Package Exports

nodebb-plugin-openapi-spec

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nodebb-plugin-openapi-spec) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

nodebb-plugin-openapi-spec

openapi spec auto-generator for nodebb api

Config page

Screen Shot 2019-11-16 at 2 49 53 PM

Spec JSON response

Screen Shot 2019-11-16 at 2 51 31 PM

Swagger UI Page

Screen Shot 2019-11-16 at 2 51 40 PM

Disclaimer

This plugin currently supports OpenApi V2, V3 is in the works.
This plugin is based on NodeBB/express-oas-generator, which is a extensively modified fork of mpashkovskiy/express-oas-generator
This plugin continuously parses every HTTP request to add/edit the spec, so it might actually slow down your nodebb instance, as also mentioned here