A UI5 CLI middleware that runs a CDS server inside the UI5 dev server, mounted at a path the UI5 project configures, so one command serves the app and its CAP services.
A UI5 CLI project's dev server serves the app, and the CAP services it calls run in a second process started and stopped on its own. This middleware calls cds serve and embeds the express middlewares it returns into the UI5 dev server, so one command answers both: it is entered under server/customMiddleware in ui5.yaml, where mountPath sets the url the CDS server answers on and moduleId names the npm package the CDS server is loaded from. Its default options are with-mocks and in-memory?, which start in-process mock services for required services that have no external binding and add a transient in-memory database bootstrapped on each restart. It is the counterpart of cds-plugin-ui5cds-plugin-ui5cds-pluginA CDS plugin that runs the UI5 CLI express middlewares inside the CDS server, so a UI5 CLI project is served from the same port as the services, mounted under a path from its ui5.yaml.community org, cap, which embeds the other way round, the UI5 CLI middlewares inside the CDS server; the repository's own comparison of the six tools that connect a UI5 app to a backend lists both, and separates them on which of the two embeds the CAP server. In a project it is one development dependency of the UI5 project, on @ui5/cli@ui5/clicliThe UI5 Tooling command line for project setup, the local dev server and the build, which defines a UI5 project's shape and its two extension points, custom middleware and custom tasks.sap official, ui5 3 or higher.
Build and dev-server toolingUI5Build and dev-server toolingcapabilityServing an app locally and building it for deployment — proxying a backend, transpiling, bundling, and shaping the result for whatever will host it.
Requires
@sap/cds≥ 6.8.1@sap/cdsartifactThe CDS server it embeds: the middleware calls cds serve internally to create the middleware functions and puts them into the UI5 development server.@ui5/cli@ui5/cliartifactThe dev server it plugs into as a custom middleware, and the specVersion: "3.0" its configuration is written against.
Who is behind it
Peter MuessigPeter MuessigPersonMaintains this In the atlas: maintains 14, contributes to 80, wrote 1@petermuessigUI5 CommunityUI5 CommunityOrganisationMaintains this In the atlas: maintains 69@ui5-communitymaintainersDimitar FenerskiPersonContributes to this In the atlas: contributes to 23@dfenerskiDominik FeiningerPersonContributes to this In the atlas: contributes to 11@dominikfeiningerFlorian VogtPersonContributes to this In the atlas: contributes to 50, wrote 2@flovogtDominik HeimPersonContributes to this In the atlas: contributes to 25@heimwege4 contributors
What it declares
Every artifact
Type
Build tool
Origin
By a community org
Runtime
Node.js
declared
As a build tool
Declared for
>=6.8.1
declared, the peer range, as published
Distributed through
npm
declared, How the tool is added to a project, as its documentation says., read npm add ui5-middleware-cap -D — ui5-middleware-cap — README, 2026-10-18
Connections5
Group by
NodeRelationConditionBasis
Functional2
cds-plugin-ui5cds-plugin-ui5cds-pluginUI5 CLI middlewares running inside the CDS servercommunity org, cap
→alternative to
none
authored
alternative to cds-plugin-ui5
Functional, authored
UI5 CLI middlewares running inside the CDS server
Build and dev-server toolingBuild and dev-server toolingcapabilityServing an app locally and building it for deploymentSAP and community, narrow by design
→provides
Registers a UI5 CLI custom middleware that calls `cds serve` and embeds the CDS server's express middlewares into the dev server, at the url `mountPath` names and from the npm package `moduleId` names.
provides Build and dev-server tooling
Functional, stated
For
Registers a UI5 CLI custom middleware that calls `cds serve` and embeds the CDS server's express middlewares into the dev server, at the url `mountPath` names and from the npm package `moduleId` names.
Basis
“UI5 CLI middleware embedding the CDS server middlewares (CAP)”ui5-middleware-cap — npm, checked “The `ui5-middleware-cap` is a UI5 CLI middleware which is used to improve the development experience for the node runtime of the SAP Cloud Application Programming Model (CAP) and enables the integration of a CDS server into the UI5 development server via the CDS server express middlewares.”ui5-middleware-cap — README, checked “If specified, the CDS server will be available at the specified url.”ui5-middleware-cap — README, mountPath, checked “If specified, the CDS server will be loaded from the NPM package with the given moduleId (package name).”ui5-middleware-cap — README, moduleId, checked
stated
provides Build and dev-server tooling
Functional, stated
For
Registers a UI5 CLI custom middleware that calls `cds serve` and embeds the CDS server's express middlewares into the dev server, at the url `mountPath` names and from the npm package `moduleId` names.
Basis
“UI5 CLI middleware embedding the CDS server middlewares (CAP)”ui5-middleware-cap — npm, checked “The `ui5-middleware-cap` is a UI5 CLI middleware which is used to improve the development experience for the node runtime of the SAP Cloud Application Programming Model (CAP) and enables the integration of a CDS server into the UI5 development server via the CDS server express middlewares.”ui5-middleware-cap — README, checked “If specified, the CDS server will be available at the specified url.”ui5-middleware-cap — README, mountPath, checked “If specified, the CDS server will be loaded from the NPM package with the given moduleId (package name).”ui5-middleware-cap — README, moduleId, checked
Serving an app locally and building it for deployment
Technical3
ui5-bookshop-viewerui5-bookshop-viewersampleUI5 app consuming the cds-bookshop server via ui5-middleware-capcommunity org, ui5
←needed by
The middleware the viewer demos: it is what puts the CAP server into the UI5 server that serves the app.
needed by ui5-bookshop-viewer
Technical, derived, through inverted from its requires edge
For
The middleware the viewer demos: it is what puts the CAP server into the UI5 server that serves the app.
UI5 app consuming the cds-bookshop server via ui5-middleware-cap
@sap/cds@sap/cdspackageCAP Node.js runtimesap official, cap
→needs
The CDS server it embeds: the middleware calls `cds serve` internally to create the middleware functions and puts them into the UI5 development server.
needs @sap/cds
Technical, declared
For
The CDS server it embeds: the middleware calls `cds serve` internally to create the middleware functions and puts them into the UI5 development server.
Basis
“Allows to provide some CLI options for the `cds serve` command which is called internally to create the middleware functions and embed them into the UI5 development server:”ui5-middleware-cap — README, options, checked “"@sap/cds": ">=6.8.1"”ui5-middleware-cap — package.json, peerDependencies, checked
declared
needs @sap/cds
Technical, declared
For
The CDS server it embeds: the middleware calls `cds serve` internally to create the middleware functions and puts them into the UI5 development server.
Basis
“Allows to provide some CLI options for the `cds serve` command which is called internally to create the middleware functions and embed them into the UI5 development server:”ui5-middleware-cap — README, options, checked “"@sap/cds": ">=6.8.1"”ui5-middleware-cap — package.json, peerDependencies, checked
CAP Node.js runtime
@ui5/cli@ui5/clicliUI5 Tooling command line for project setup, dev server and buildsap official, ui5
→needs
The dev server it plugs into as a custom middleware, and the `specVersion: "3.0"` its configuration is written against.
needs @ui5/cli
Technical, declared
For
The dev server it plugs into as a custom middleware, and the `specVersion: "3.0"` its configuration is written against.
Basis
“All releases of this UI5 CLI extension using the major version `3` require UI5 CLI V3.”ui5-middleware-cap — README, Prerequisites, checked “"@ui5/cli": ">=3"”ui5-middleware-cap — package.json, peerDependencies, checked
declared
needs @ui5/cli
Technical, declared
For
The dev server it plugs into as a custom middleware, and the `specVersion: "3.0"` its configuration is written against.
Basis
“All releases of this UI5 CLI extension using the major version `3` require UI5 CLI V3.”ui5-middleware-cap — README, Prerequisites, checked “"@ui5/cli": ">=3"”ui5-middleware-cap — package.json, peerDependencies, checked
UI5 Tooling command line for project setup, dev server and build
👋 This is an open‑source, community‑driven project, developed and actively monitored by members of the UI5 community. You are welcome to use it, report issues, contribute enhancements, and support others in the community.
The ui5-middleware-cap is a UI5 CLI middleware which is used to improve the development experience for the node runtime of the SAP Cloud Application Programming Model (CAP) and enables the integration of a CDS server into the UI5 development server via the CDS server express middlewares. In addition to the middleware the CDS server project needs to be added as dependency so that the server is detected and attached properly. The pre-defined routes in the CDS server are reused.
⚠️ UI5 CLI Compatibility
All releases of this UI5 CLI extension using the major version 3 require UI5 CLI V3. Any previous releases below major version 3 (if available) also support older versions of the UI5 CLI. But the usage of the latest UI5 CLI is strongly recommended!
moduleId: <string>
If specified, the CDS server will be loaded from the NPM package with the given moduleId (package name). If not provided, the middleware will lookup the CDS server from the project dependencies or devDependencies.
mountPath: <string>
If specified, the CDS server will be available at the specified url.
options: <object> (default: { "with-mocks": true, "in-memory?": true } )
Allows to provide some CLI options for the cds serve command which is called internally to create the middleware functions and embed them into the UI5 development server:
with-mocks: <boolean>
It starts in-process mock services for all required services configured in package.json#cds.requires, which don't have external bindings in the current process environment.
in-memory[?]: <boolean>
Automatically adds a transient in-memory database bootstrapped on each (re-)start in the same way cds deploy would do, based on defaults or configuration in package.json#cds.requires.db. Add a question mark to apply a more defensive variant which respects the configured database, if any, and only adds an in-memory database if no persistent one is configured.
Support
Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.
Contributing
Any type of contribution (code contributions, pull requests, issues) to this set of UI5 CLI extensions will be equally appreciated.
Built with care (and a lot of caffeine). If this helped you build, test, or ship, the next coffee — or drink — is on you when you bump into a contributor.
#13733c544b7 Thanks @petermuessig! - Bump the express peerDependency floor from >=4.18.2 to >=4.19.2 so the declared range no longer permits versions affected by GHSA-rv95-896h-c2vc (open redirect). Closes Dependabot alerts #110, #111, #113, #114, #115, #117.
All notable changes to this project will be documented in this file.
See Conventional Commits for commit guidelines.
cds-plugin-ui5cds-plugin-ui5cds-pluginA CDS plugin that runs the UI5 CLI express middlewares inside the CDS server, so a UI5 CLI project is served from the same port as the services, mounted under a path from its ui5.yaml.community org, capUI5 CLI middlewares running inside the CDS server
Build and dev-server toolingBuild and dev-server toolingcapabilityServing an app locally and building it for deployment — proxying a backend, transpiling, bundling, and shaping the result for whatever will host it.SAP and community, narrow by design
UI5 ToolsUI5 Toolside-extensionA VS Code extension for UI5 developers that serves, proxies, builds and deploys UI5 projects from one workspace-wide configuration, with live reload, a Gateway deployer and a BSP importer.independent, ui5VS Code extension to serve, proxy, build and deploy UI5 projects
ui5-middleware-route-proxyui5-middleware-route-proxybuild-toolA UI5 server middleware that forwards requests matching a route prefix to a backend host, configured per route in ui5.yaml, with credentials read from a .env file rather than the yaml.independent, ui5UI5 server middleware proxying route prefixes to a backend
ui5-task-cachebuster-indexingui5-task-cachebuster-indexingbuild-toolA UI5 builder task that copies the build output into a timestamped folder inside dist so the UI5 cachebuster can resolve it; it supports timestamps only, not the hash mode.independent, ui5UI5 builder task preparing build output for the cachebuster
ui5-task-transpile-genui5-task-transpile-genbuild-toolA UI5 builder task that transpiles ES6 to ES5, including async/await, with Babel at build time, registered in ui5.yaml with a bundle definition that includes the regenerator runtime.independent, ui5UI5 builder task transpiling ES6 to ES5 with Babel
ui5-middleware-odata-recorderui5-middleware-odata-recorderbuild-toolA UI5 server middleware that records the OData traffic a running app makes against a real backend and writes entity JSON files and metadata.xml that the Fiori elements mock server can replay.independent, ui5UI5 middleware recording OData traffic as mock server datasets
ui5-plugin-loaderui5-plugin-loaderbuild-toolA UI5 Tooling v4 extension that registers a project's other extensions itself: one entry in ui5.yaml, and every dependency carrying a ui5-plugin-loader.json manifest is mounted as middleware and as a build task.independent, ui5UI5 Tooling v4 extension that registers other extensions
ui5-deployerui5-deployercliA custom module for UI5 Tooling that deploys Fiori/UI5 apps to SAP NetWeaver ABAP, SAP Cloud Platform Neo or Cloud Foundry, configured in a deployer section of ui5.yaml.independent, ui5UI5 Tooling module deploying Fiori/UI5 apps to SAP systems
ui5-task-dts-generatorui5-task-dts-generatorbuild-toolA UI5 builder task that generates d.ts files, TypeScript type declarations, during the build of a UI5 library written in JavaScript, by wrapping @ui5/dts-generator.independent, ui5UI5 builder task generating d.ts type declarations
ui5-task-minifierui5-task-minifierbuild-toolA UI5 builder task that minifies the HTML, CSS and JSON files the UI5 builder leaves as they are, with one switch per file type, using html-minifier-terser and clean-css.independent, ui5UI5 builder task minifying HTML, CSS and JSON files
ui5-middleware-oidcui5-middleware-oidcbuild-toolA UI5 Tooling server middleware that puts an OpenID Connect login in front of the UI5 dev server, built on express-openid-connect, which receives its configuration block as written.independent, ui5UI5 dev server middleware adding an OpenID Connect login
generator-ui5-library-af-deploygenerator-ui5-library-af-deploygeneratorA Yeoman generator that writes the SAP BTP Application Frontend deployment configuration, mta.yaml, ui5-deploy.yaml, xs-app.json and xs-security.json, into an existing UI5 library project.independent, ui5Yeoman generator for Application Frontend config in UI5 libraries
ui5-middleware-destinationui5-middleware-destinationbuild-toolA UI5 Tooling server middleware that proxies requests to backends named in WebIDE-style destination files and serves the routes of a neo-app.json, with Basic Authentication only.independent, ui5UI5 Tooling middleware proxying destinations and neo-app.json routes
ui5-task-check-eocpui5-task-check-eocpbuild-toolA UI5 builder task that matches the UI5 version in ui5.yaml against the versions retrieved from ui5.sap.com and warns during the build once that version's End of Cloud Provisioning quarter has been reached.independent, ui5UI5 build task warning when the app's UI5 version reaches EOCP
@ui5/cli@ui5/clicliThe UI5 Tooling command line for project setup, the local dev server and the build, which defines a UI5 project's shape and its two extension points, custom middleware and custom tasks.sap official, ui5UI5 Tooling command line for project setup, dev server and build
ui5-task-btp-manifestui5-task-btp-manifestbuild-toolA UI5 Tooling custom task that writes the surrounding app's sap.cloud service name into the bundled Spreadsheet Importer's manifest at build time, so the two match on SAP BTP.community org, ui5UI5 Tooling task writing the service name into the importer manifest
ui5-middleware-approuterui5-middleware-approuterbuild-toolA UI5 CLI middleware that puts @sap/approuter in front of the UI5 dev server, proxying it to Cloud Foundry or XS Advanced destinations during development.community org, ui5UI5 CLI middleware proxying the dev server through @sap/approuter
ui5-middleware-hmrui5-middleware-hmrbuild-toolAn experimental UI5 middleware for hot module replacement, swapping a changed module in during development instead of reloading the whole page.community org, ui5Experimental UI5 middleware for hot module replacement
ui5-middleware-iasyncui5-middleware-iasyncbuild-toolA UI5 dev-server middleware built on browsersync.io that syncs user interactions across connected browsers over a websocket, replaying an action from one browser in the others for manual testing.community org, ui5UI5 middleware syncing interactions across browsers over websocket
ui5-middleware-indexui5-middleware-indexbuild-toolA UI5 dev-server middleware that delivers a configured welcome page, index.html by default, for the root path instead of the ui5-server directory listing.community org, ui5UI5 middleware serving a chosen welcome page at the root path
ui5-middleware-livereloadui5-middleware-livereloadbuild-toolA dev-server middleware that adds live reload to the UI5 dev server, reloading the page when the sources in the app's webapp folder change.community org, ui5Live reload middleware for the UI5 dev server
ui5-middleware-oneloginui5-middleware-oneloginbuild-toolA UI5 dev-server middleware that logs into a system such as SAP Gateway with headless Playwright on the first request and reuses the session cookie for every later request.community org, ui5UI5 middleware logging in with Playwright and reusing the session
ui5-middleware-serveframeworkui5-middleware-serveframeworkbuild-toolA UI5 middleware that serves a UI5 framework built on the local machine to the dev server, in place of a framework version resolved another way.community org, ui5UI5 middleware serving a locally built UI5 framework
ui5-middleware-servestaticui5-middleware-servestaticbuild-toolA UI5 dev-server middleware that serves static resources from a filesystem path or an installed npm package path, built on serve-static, with either path settable through an environment variable.community org, ui5UI5 middleware serving static resources from a path or npm package
ui5-middleware-simpleproxyui5-middleware-simpleproxybuild-toolA UI5 dev-server middleware that proxies requests from the local dev server to a backend system, so the app can reach the backend's services during development.community org, ui5Dev-server middleware proxying requests to a backend system
ui5-middleware-ui5ui5-middleware-ui5build-toolA UI5 middleware that lets one UI5 application be included as a dependency of another and served through that application's dev server.community org, ui5UI5 middleware including one UI5 application in another
ui5-middleware-webjarsui5-middleware-webjarsbuild-toolA UI5 dev-server middleware that loads JAR files from a configured path and serves the static resources bundled inside them, following the WebJars convention of META-INF/resources/.community org, ui5UI5 middleware serving static resources from JAR files (WebJars)
ui5-middleware-websocketui5-middleware-websocketbuild-toolUI5 middleware utilities that add WebSocket support to Express-based dev servers such as the UI5 server, which has no WebSocket channel of its own.community org, ui5WebSocket support for Express-based dev servers such as UI5's
ui5-task-cachebusterui5-task-cachebusterbuild-toolA UI5 builder task that cachebusts a standalone UI5 application by moving its build output into a timestamped subfolder and pointing index.html's resource roots at it.community org, ui5UI5 builder task cachebusting standalone UI5 applications
ui5-task-copyrightui5-task-copyrightbuild-toolA UI5 builder task that appends copyright headers to TypeScript, JavaScript and XML files on every build, so the header is not added to each source file by hand.community org, ui5UI5 builder task appending copyright headers to source files
ui5-task-flatten-libraryui5-task-flatten-librarybuild-toolA UI5 builder task that flattens a library's build output, removing the project namespace and resources folder for deployment to SAP NetWeaver, now also offered by the UI5 CLI itself.community org, ui5UI5 builder task flattening library output for SAP NetWeaver
ui5-task-i18ncheckui5-task-i18ncheckbuild-toolA UI5 builder task that cross-checks every XML view against the app's i18n properties files and logs a warning where a translation is missing; views created in JavaScript are not checked.community org, ui5UI5 builder task checking XML views for missing i18n texts
ui5-task-minify-xmlui5-task-minify-xmlbuild-toolA UI5 builder task that minifies XML resources such as views and fragments, which a plain UI5 build otherwise ships unminified.community org, ui5UI5 builder task minifying XML views and fragments
ui5-task-pwa-enablerui5-task-pwa-enablerbuild-toolA UI5 builder task that turns a UI5 application into a progressive web app by generating a web manifest and a service worker under one of five caching strategies.community org, ui5UI5 builder task turning a UI5 app into a progressive web app
ui5-task-zipperui5-task-zipperbuild-toolA build task for the UI5 tooling that packages the UI5 build result, the webapp, as a zip archive at the end of the build.community org, ui5Build task packaging the UI5 build result as a zip archive
ui5-tooling-lessui5-tooling-lessbuild-toolA UI5 CLI extension, a build task and a dev-server middleware, that compiles an app's Less files into CSS at build time and live while the UI5 server runs.community org, ui5UI5 CLI extension compiling Less files into CSS
ui5-tooling-modulesui5-tooling-modulesbuild-toolA set of UI5 tooling extensions that load and convert plain npm packages into UI5 AMD-like modules, so the UI5 module loader can consume them.community org, ui5UI5 tooling extensions loading npm packages as UI5 modules
ui5-tooling-stringreplaceui5-tooling-stringreplacebuild-toolA UI5 CLI extension for string replacement during the build, for placeholders or tokens in source files that have to be replaced at build time.community org, ui5UI5 CLI extension for string replacement during the build
ui5-tooling-transpileui5-tooling-transpilebuild-toolA UI5 CLI extension that transpiles modern JavaScript or TypeScript during the UI5 build, with a transformJSX option that handles JSX and TSX in the same step.community org, ui5UI5 CLI extension transpiling code during the UI5 build
@ui5/logger@ui5/loggerpackageUI5 CLI's internal logger, described by its own readme as internal — it appears here because other UI5 tooling depends on it.sap official, ui5Internal logger of the UI5 CLI
@ui5/middleware-code-coverage@ui5/middleware-code-coveragebuild-toolUI5 CLI server middleware that instruments a project's JavaScript files with Istanbul as the dev server sends them, and generates the coverage report from the records the OpenUI5 QUnit tests send back.sap official, ui5UI5 CLI middleware for Istanbul code coverage
@ui5/tooling-webc@ui5/tooling-webcbuild-toolDeprecated UI5 Tooling extensions that generate UI5 library wrapper projects for UI5 Web Components and serve them during development; the README points to ui5-tooling-modules instead.sap official, ui5Deprecated UI5 Tooling extensions for UI5 Web Components wrappers
A UI5 CLI project's dev server serves the app, and the CAP services it calls run in a second process started and stopped on its own. This middleware calls `cds serve` and embeds the express middlewares it returns into the UI5 dev server, so one command answers both: it is entered under `server/customMiddleware` in `ui5.yaml`, where `mountPath` sets the url the CDS server answers on and `moduleId` names the npm package the CDS server is loaded from. Its default options are `with-mocks` and `in-memory?`, which start in-process mock services for required services that have no external binding and add a transient in-memory database bootstrapped on each restart. It is the counterpart of [cds-plugin-ui5](artifact:ui5-community-cds-plugin-ui5), which embeds the other way round, the UI5 CLI middlewares inside the CDS server; the repository's own comparison of the six tools that connect a UI5 app to a backend lists both, and separates them on which of the two embeds the CAP server. In a project it is one development dependency of the UI5 project, on [@ui5/cli](artifact:sap-ui5-cli) 3 or higher.
UI5 CLI middleware that runs a CDS server inside the UI5 dev server, mounted at a path the UI5 project configures.
capability:ui5-build-tooling, with what_it_does and the README's own sentences on the middleware, mountPath and moduleId
The maintainers publish the two as members of one set and compare them in one table. The repository README: "Six tools in this repo can connect a UI5 app to a backend (`cds-plugin-ui5`, `ui5-middleware-cap`, `ui5-middleware-approuter`, `@sap/approuter`, `dev-approuter`, `ui5-middleware-simpleproxy`)." The comparison in docs/backend-connectivity.md is what separates this pair: "| Embeds CAP server | ❌ | ✅ | (✅)¹ | ❌ | ✅ | (✅)¹ |", the first two columns being cds-plugin-ui5 and ui5-middleware-cap. The inverse edge is derived, so cds-plugin-ui5 shows it without being edited.
runtimes node, cds_range >=6.8.1
artifact:sap-cds, artifact:sap-ui5-cli
Peter Muessig, actor:petermuessig and actor:ui5-community
