Export Swagger definition about express-jsdoc-swagger HOT 2 CLOSED

Hi @alexwaibel ,

You already have an option to get the JSON result of your endpoints. 👍 You can check out this example.

In that example, if you define one variable you can subscribe to some events like finish. That event exposes the JSON OpenAPI result.

Therefore, you can do this:

// Define variable
const listener = expressJSDocSwagger(app)(options);

listener.on('finish', swaggerObject => {
  console.log(JSON.stringify(swaggerObject, null, 2)); // This will print JSON OpenAPI result
});

Then you will get the OpenAPI JSON output and that result. You can use that result to generate a YAML maybe using a script to parse the JSON to YAML (json-to-yaml) and add it to your CI. Right now, we don't provide an option to generate the YAML result but only JSON. Maybe we could consider it for future releases.

I hope this helps you. You can find more info on our docs page.

from express-jsdoc-swagger.

Another option would be to expose it using the feature update in 1.3.0.

Just set exposeApiDocs to true in your project and apiDocsPath to the correct path (defaults to /v3/api-docs).

See https://www.npmjs.com/package/express-jsdoc-swagger#usage for reference.

from express-jsdoc-swagger.