react,vue编写接口文档

1. 安装模块

npm i apidoc --global

2.配置packag.json

在文件最底部

"apidoc": {
  "title": "ERP admin pro", //随便取
  "url" : "http://localhost:3001/"   //项目的端口号
}

3.编写接口文档

在路由的配置前添加如下代码（星号注释起来的部分）
注意一定要写在路由的前面，不然不起作用

var router = require('express').Router()
var sql = require('./../sql')
var Navcategory = require('./../sql/models/Navcategory')
var Navlist = require('./../sql/models/Navlist')
var utils = require('./../utils')
/**
 * @api {get} /api/nav/navcategory 获取导航分类  //读取文件的目录及接口名
 * @apiName GetNavCategory
 * @apiGroup Nav
 *
 * @apiSuccess {String} code 状态码.
 * @apiSuccess {String} message  描述
 * @apiSuccess {String} data  数据
 *
 * @apiSuccessExample Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "code": "200",
 *       "message": "导航的分类数据",
 *       "data": []
 *     }
 * @apiSampleRequest /api/nav/navcategory
 */
router.get('/navcategory', (req, res, next) => {
  sql.find(Navcategory, {}, { _id: 0, __v: 0 }).then(data => {
    res.status('200').send({
      code: '200',
      message: '导航的分类数据',
      data
    })
  })
})
/**
 * @api {get} /api/nav/navlist 获取导航列表
 * @apiName GetNavList
 * @apiGroup Nav
 *
 * @apiSuccess {String} code 状态码.
 * @apiSuccess {String} message  描述
 * @apiSuccess {String} data  数据
 *
 * @apiSuccessExample Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "code": "200",
 *       "message": "导航列表",
 *       "data": []
 *     }
 * @apiSampleRequest /api/nav/navlist
 */
router.get('/navlist', (req, res, next) => {
  sql.find(Navlist, {}, { _id: 0, __v: 0 }).then(data => {
    res.status('200').send({
      code: '200',
      message: '导航列表',
      data
    })
  })
})

module.exports = router

4.生成在线接口文档

apidoc -i api/ -o public/apidoc

api/ : 想要生成接口文档的文件目录
-o : output 输出文档
public/apidoc : 输出文档的目录

通过 http://localhost:3001/apidoc 访问当前的接口文档，或者打开public/apidoc查看.(路径自改)