Light

rawmind / express-autodoc Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 130 KB

API documentation generator based on jsdoc comments for express

License: MIT License

JavaScript 100.00%

express-autodoc's Introduction

express-autodoc

API documentation generator based on jsdoc comments for express

Quick start

Install

npm install express-autodoc --save-dev

Add documentation for your Express.js endpoint

/**
 * @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,
  })
));

Generate swagger mapping

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

Supported tags

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

See more examples: simple app, app with router

express-autodoc's People

Contributors

Stargazers

Watchers

express-autodoc's Issues

Parse `description` tag

Parse query parameters

/**
 * @description Get songs
 * @queryParam (title) {type: string, required: true, default: Sad but true} The song title
 */
app.get('/api/v1/songs', (req, res) => (
  res.json({
    title: req.title,
  })
));

Support module import (`import` directive)

Add @pathParam tag for mapping path variable with its description

/**
 *  @description Insert a new song
 *  @pathParam (:id) The song id
 */
app.put('/api/v1/song/:id/*', (_req, res) => (
  res.json({
    title: 'abum 1',
  })
));

Add produces tag

/**
 * @description Get songs
 * @queryParam (title) {type: string, required: true, default: Sad but true} The song title
 * @produces application/json, application/xml
 */
app.get('/api/v1/songs', (req, res) => (
  res.json({
    title: req.title,
  })
));

Parse path parameters

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.