Back to Bricks

Swagger Docs

Dev Tools

Auto-generated API documentation using Swagger UI. Reads definitions from JSDoc comments.

swaggerdocsopenapifrontend
Backend:
models/Swagger Docs.jsjavascript
1// No model

Paste Guide

Copy files to:

models/Swagger Docs.jscontrollers/docsController.jsroutes/docsRoutes.js

Add to server.js:

app.use('/api/docs', require('./routes/docsRoutes'));

Stack

ExpressSwagger

Test Examples

# Open http://localhost:5000/api/docs in browser