openapi spec generator

Usage no npm install needed!

<script type="module">
  import nodebbPluginOpenapiSpec from '';



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


  • 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