Skip to content

Releases: chgeo/cds-swagger-ui-express

v0.8.0

18 Jan 18:03
Compare
Choose a tag to compare

Added

  • 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.

v0.7.0

04 Dec 17:46
Compare
Choose a tag to compare

Changed

  • Requires @sap/cds ^7
  • Requires @sap/cds-dk ^7
  • Requires swagger-ui-express / swagger-ui ^5
  • Drops Node 14 and 16 support. Minimum Node version is now 18.

Added

  • New option odataVersion to specify the OData version used to compile the OpenAPI specs

Fixed

  • Works with @sap/cds 7.4 again

v0.6.0

27 Feb 16:28
71c2a64
Compare
Choose a tag to compare

Version 0.6.0 - 2023-02-27

Added

  • Way to pass swagger (UI) options. See README.md.
  • JSDoc type definitions for options.

Changed

  • 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

v0.5.0

09 Jun 12:27
Compare
Choose a tag to compare

What's Changed

  • Add apiPath option for usage behind reverse proxy by @rahxam in #13
  • Bump jest from 27.5.1 to 28.0.1 by @dependabot in #12

New Contributors

Full Changelog: v.0.4.0...v0.5.0

v0.4.0

04 Apr 11:07
Compare
Choose a tag to compare
v.0.4.0

Restore preview label

v0.2.0

12 Jul 11:44
Compare
Choose a tag to compare
More robust options handling

v0.1.1

06 Jul 13:56
Compare
Choose a tag to compare
  • Smaller package
  • Updated sample code

v0.1.0

02 Jul 19:22
Compare
Choose a tag to compare

Initial release