❤
npm
Sign UpSign In

nodebb-plugin-openapi-spec

1.0.0 • Public • Published

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

Readme

Keywords

Package Sidebar

Install

npm i nodebb-plugin-openapi-spec

Repository

github.com/NodeBB/nodebb-plugin-openapi-spec

Homepage

github.com/NodeBB/nodebb-plugin-openapi-spec#readme

Weekly Downloads

4

Version

1.0.0

License

ISC

Unpacked Size

13.7 kB

Total Files

8

Last publish

Collaborators

  • akhoury
Try on RunKit
Report malware