express-jsdoc-swagger
express-jsdoc-swagger copied to clipboard
BRIKEV
Swagger OpenAPI 3.x generator
**Is your feature request related to a problem? Please describe.** I need to read files from node_modules which contain jsdoc definitions of components, but it's not allowed. **Describe the solution...
**Description** Json object type required body may contain optional keys. This should be documentable both using the interface notation and form options. **To Reproduce** ``` /** * @param {object} request.body.required...
I see there are options `exposeApiDocs` and `apiDocsPath`, but the question, is it possible to write generated spec to file without running the express app? This is very useful if...
I tryied to specify plain text message in the response section: ``` /* * @return {string} 200 - success response - text/html * @example response - 200 - success response...
The types of the components are always assumed to be object. Generally, enums are allowed to be components and they can have integer or string types. Example enum component: ```json...
Hello. In my API I have a request which requires to pass param/property which is array of enum elements. To defined I used the following annotation ```javascript /** * @typedef...
**Describe the bug** I am working with GeoJSON data and the data is represented as the following: ```json { "type":"MultiLineString", "coordinates":[ [ [ 10, 10, 0 ], [ 20, 20,...
When I'm defining a schema consisting of types containing properties, it would be handy to specify the example values which should appear in the request & response examples that reference...
**Describe the bug** Authentication not working with oauth2. **To Reproduce** Trying to implement oauth2 according to swagger documentation. ``` security: { BearerAuth: { type: "oauth2", scheme: "bearer", }, } ```...
I can't seem to find anything in the source/examples with defining a response header Is this a feature not yet available or have I missed the relevant examples?
