node与apidoc写接口文档

作者:神秘网友发布时间:2020-09-09 12:54:04

node与apidoc写接口文档

官网 http://apidocjs.com
npm i apidoc -g

{
  "name": "宝贝持有者的心情记录",
  "version": "1.0.0",
  "description": "宝贝持有者的心情记录项目API文档", 
  "title": "cms-server API", 
  "url" : "http://localhost:3000/v1",
  "sampleUrl": "http://localhost:3000/v1",
  "forceLanguage":"zh-cn",
  "template": {
    "withCompare": true,
    "withGenerator": true
  }

}

node与apidoc写接口文档

新建一个文件夹，存放apidoc生成的文件，在启动文件夹下添加一句话

// app.use('/apidoc存放的位置',express.static('apidoc存放的位置'));
// 配置实例：若我放在public/apidoc,则对应配置为
app.use('/public', express.static('public'))

node与apidoc写接口文档

添加注释

   /**
     * @api {get} /getOpenid/ 获取用户 openid
     * @apiDescription  获取用户 openid
     * @apiName submit-login
     * @apiGroup User
     * @apiParam {string} loginName 用户名
     * @apiParam {string} loginPass 密码
     * @apiSuccess {json} result
     * @apiSuccessExample {json} Success-Response:
     * {
     *   "success" : "true",
     *      "result" : {
     *          "name" : "loginName",
     *          "password" : "loginPass"
     *      }
     * }
     * @apiSampleRequest http://localhost:3000/api/getOpenid/
     * @apiVersion 1.0.0
     */

node与apidoc写接口文档

生成API文档

// apidoc -i '扫描接口的文件夹' -o '生成apidoc的位置'
apidoc -i routes/ -o public/apidoc/

node与apidoc写接口文档

启动项目，访问 http:localhost:3000/public/apidoc

node与apidoc写接口文档

node与apidoc写接口文档

node与apidoc写接口文档相关教程