express-autodoc

API documentation generator based on jsdoc comments for express


Quick start

$3

``bash

npm install express-autodoc --save-dev
`

$3

`js
/**
* @description Get songs
* @queryParam (title) The song title
* @pathParam (:albumId) album UUID
* @produces application/json, application/xml
*/
app.get('/api/albums/:albumId/songs', (req, res) => (
res.json({
title: req.title,
})
));
`

$3

`bash
node -e 'require("express-autodoc").generateSwagger(".")'
`

Supported tags

| Tag | Format | Example |
|-------------------|:-------------------------------------------------------------------------------------:|-----------------------------------------:|
| @queryParam | (\) {type: string, required: true, default: \ } \ | /* @queryParam (name) A name param / |
| @pathParam | (\<:name\>) \ | /* @pathParam (:id) song Id / |
| @produces | \,\ | /* @produces application/json /| |
| @description | \ | /* @description A description / |
| @body, @request | \ [{"example": "object"} |] | / @body {} / / @body #definitions/Song / |
| @response | \ [{"example": "object"} |] | / @response {} / / @response #definitions/Song /` |

$3