feathersjs-ecosystem / feathers-swagger

Add documentation to your FeatherJS services and feed them to Swagger UI.
MIT License
226 stars 63 forks source link

Bug: Documentation for Usage with SwaggerUI #251

Closed uplke closed 1 year ago

uplke commented 1 year ago

Describe the bug Will not invoke swagger UI as described https://feathersjs-ecosystem.github.io/feathers-swagger/#/?id=installation

To Reproduce The UI option is described as being part of the specs object const app = express(feathers()) // ... .configure(swagger({ specs: { ui: swagger.swaggerUI(), ...}, }, }))

Expected behavior UI option is a top level swagger option (as correctly described in the API section): const app = express(feathers()) // ... .configure(swagger({ ui: swagger.swaggerUI(), specs: { ... }, }))

Thanks for this awesome project!