@dreygur/expressdoc

Express Doc

express.js rest api docs with Swagger UI

Usage:

const { ExpressDoc } = require('expressdoc');
const app = new ExpressDoc({
  title: "Documentation", // Title of the app or for documentation page
  version: "5.0.1", // App version
  docPath: "/doc", // Documentation PATH
  apiPaths: ["./routes"], // PATH locations to the files where api is implemented
  SwaggerUiOptions // Options for Swagger UI
});

Or:

const expressDoc  = require('expressdoc');
const app = expressDoc();
// You can also pass the arguments to above function

The rest will be as express.js

Whatever can be done with express.js is possible with ExpressDoc as it just a wrapper of express with just the Swagger UI included for documentation generation.

---

Made with ❤️ from 🇧🇩