CDS pluginCDS plugintypeInstalls into a CAP project and extends the runtime. CAP loads it through cds.requires or the plugin hook.See every one →What this type is →independently maintainedindependently maintainedoriginPublished by one person or a small company outside SAP. Says nothing about quality; the readings say that.See every one →
cds-swagger-ui-express
Serves a CAP service's OpenAPI definition as a browsable Swagger UI, which is the page @cap-js/openapi@cap-js/openapicds-pluginTurns a CDS service into an OpenAPI document, derived from the model so the description cannot drift from what is served.sap official, cap's document does not come with.
OpenAPICAPOpenAPIcapabilityHanding a description of the service to clients and tools — an API portal, a code generator, a partner who wants a contract before they write anything.
@sap/cds≥ 7@sap/cdsartifactThe peer range, as published.
Who is behind it
Christian GeorgiChristian GeorgiPersonMaintains this In the atlas: maintains 1, contributes to 53@chgeomaintainerbandlowPersonContributes to this In the atlas: contributes to 1@bandlowDaniel HutzelPersonContributes to this In the atlas: contributes to 32, wrote 3@danjoaGregor WolfPersonContributes to this In the atlas: maintains 17, contributes to 59, wrote 2@gregorwolfYannick WinterPersonContributes to this In the atlas: contributes to 1@kyc34 contributors
Before choosing this
crawled
Conditions
LicenceSAP Developer License Agreement 3.2 CAP§ 1, 2, 3A cds-plugin is used with SAP CAP materials, or an artifact is explicitly identified as a CAP plugin or application.
Derived: the instrument's applicability matches this artifact, checked
§ 1License. Productive customer applications are limited to SAP BTP or another SAP-licensed platform, and mass extraction to a non-SAP product is restricted except where solely required for SAP interoperability.
§ 2Intellectual Property. The agreement retains SAP's rights in the covered materials and limits making APIs, tools or software available to third parties, while preserving ownership of customer applications subject to SAP's underlying rights.
§ 3Artificial Intelligence Training. The agreement prohibits use of the covered materials and customer applications for training artificial-intelligence models or systems.
declared, How the plugin is installed into a CAP project, as its documentation says., read npm add --save-dev cds-swagger-ui-express — cds-swagger-ui-express — README, 2026-10-18
Connections1
Group by
NodeRelationConditionBasis
Functional1
OpenAPIOpenAPIcapabilityHanding a service description to clients and toolsSAP and community, narrow by design
→provides
none
authored
provides OpenAPI
Functional, authored
Handing a service description to clients and tools
Derived from the package name. No recipe recorded; the README has the configuration.
Learn more2
Readings
Part 2 – Empowering SAP BTP CAP Services through Open API Spec and Annotations for Effective Communication, Collaboration and GovernancePart 2 – Empowering SAP BTP CAP Services through Open API Spec and Annotations for Effective Communication, Collaboration and GovernanceblogWalks through generating an OpenAPI specification for a Node.js CAP service: installing cds-swagger-ui-express, bootstrapping it in server.js, a sample CDS data model with associations and compositions, and the YUML diagram and endpoint details the Open API Preview renders in Business Application Studio. Also shows gating the Swagger UI behind a user-defined environment variable so it is served in development and QA subaccounts but excluded from the production deployment on Cloud Foundry. Second of a three-part series; the first covers the concepts and the third goes deeper into annotations.mohit_bansal3, published 2023-05-24mohit_bansal3, SAP Community
Adding a Swagger UI to Your SAP Cloud Application Programming Model / Node.js ServiceAdding a Swagger UI to Your SAP Cloud Application Programming Model / Node.js ServiceblogThe problem stated from the other side of the wire: a CAP and HANA backend consumed by frontend developers with no SAP background, who said in the first meeting that they could not work from what the service offered. A browsable API page is the answer, and this is the post the Swagger UI plugin indexed here exists to serve.published 2020-01-23Thomas Jung, SAP Community
You can set the most prominent options in package.json or .cdsrc.json, as in other CAP apps:
"cds": { "swagger": { "basePath": "/$api-docs", // the root path to mount the middleware on "apiPath": "/", // the root path for the services (useful if behind a reverse proxy) "diagram": true, // whether to render the YUML diagram "odataVersion": "4.0" // the OData Version to compile the OpenAPI specs. Defaults to 4.01 }}
To disable the plugin, set this:
"cds": { "swagger": false}
Note that you can also set environment variables for each option, like CDS_SWAGGER=false. See the cds.env docs for more.
Programmatic Usage (advanced)
If you need to register the plugin programmatically, e.g. in certain conditions only, you can do so in your server.js:
In this case, the default 'auto registration' as plugin is disabled automatically to avoid conflicts.
Programmatic Configuration
If the middleware is registered programmatically, you need to pass in the options through the API as well. No configuration from package.json is used here.
Call cds_swagger ({...}) with the following object as first parameter:
{ "basePath": ..., // see section above for more}
Swagger UI Options
Call cds_swagger ({...}, {...}) with an additional object as second parameter. This object is passed to swagger-ui-express as custom options.
Example:
{ "customSiteTitle": "My Custom Title", "swaggerOptions": { "requestInterceptor": ... }}
Options from package.json now get used as defaults even if the middleware is added programmatically. You can now call it w/o options but have them in package.json only, or mix them, with the programmatic options taking precedence.
Default texts have changed and are now more configurable through
@title for service title
@Core.Description for service short text
@Core.LongDescription for service description
This plugin is no longer tested with Node 18, which has reached end of life.
Fixed
Compatibility with express 5, as @sap/cds >= 9.7.0 supports it now.
The OpenAPI spec is no available for download on .../openapi.json and linked in the UI.
Changed
The default value for option apiPath is now /, allowing more flexible control over the root path where the CDS services are served. Formerly, it was not possible to set root path relative to the current host, like abc.com/1234-appid/$api-docs/..., abc.com/5678-appid/$api-docs/....
Auto-registration mode: the middleware registers itself when loaded as a CAP plugin
Declarative configuration through package.json / cds-rc.json
Programmatic registration is still possible, but disables auto mode then
Changed
Make dependency to @sap/cds-dk optional. If running with the cds executable during development, the dependency is fulfilled anyways. Only when running as part of a deployed app with cds-serve, then such a dependency is needed.
The default site title is now <Service Name> - Swagger UI (instead of just Swagger UI)
REST services are now available as well in the Swagger UI. Previously, only OData services were allowed. This was to avoid potential issues as the underlying OpenAPI transformation uses OData as intermediate protocol. So, as long as we don't see issues, allow REST services as well.
Fixed
Multiple services are now properly served, w/o the previous stale content of swagger-ui-init.js. Requires swagger-ui-express >= 4.6.2
The serving Swagger UI... log lines are not longer sent to console by default to avoid clutter in the default output. They can be enabled with DEBUG=swagger set as environment variable.
OpenAPIOpenAPIcapabilityHanding a description of the service to clients and tools — an API portal, a code generator, a partner who wants a contract before they write anything.SAP and community, narrow by design
abap-openapiabap-openapigeneratorGenerates ABAP client classes and ICF server stubs from an OpenAPI v3 document, one self-contained global class and interface per definition, through a web client, a Node.js command line or ABAP itself.independent, abapGenerates ABAP client classes and server stubs from OpenAPIfrom ABAP
@cap-js/openapi@cap-js/openapicds-pluginTurns a CDS service into an OpenAPI document, derived from the model so the description cannot drift from what is served.sap official, capGenerates OpenAPI documents from a CDS servicefrom CAP
ABAP OpenAPI UIABAP OpenAPI UIappAn ABAP app that puts a Swagger UI in front of SAP NetWeaver Gateway services, built on Swagger UI and Odata-OpenAPI, installed through abapGit and opened from transaction ZGW_OPENAPI.independent, abapSwagger UI for SAP NetWeaver Gateway servicesfrom ABAP
ABAP-SwaggerABAP-SwaggerpackageAn ABAP library that exposes a class's public methods as REST services, registered through the ZIF_SWAG_HANDLER interface, with a Swagger UI on the same base path describing them.independent, abapExposes ABAP class methods as REST services with Swagger UIfrom ABAP
