apidoc

使用 apidoc 自动生成接口文档，用于 nodejs 项目。

使用apidoc开发了两个后端程序的接口文档，来更新一下，使用心得。

使用

1. 需要在项目中生成一个apidoc.json文件，写一些我们的内容，我查阅文档说可以设置成中文，但是写了就失败。。。

   {
     "name": "大森林商店",
     "version": "0.1.0",
     "description": "baseURL：http://websong.wang:1000 购物车/订单接口需要请求头携带token",
     "title": "大森林商店后台接口文档"
   }

2. 然后就可以在router.js的接口函数中写文档注释了

   /**
      * @api {get} /rl 分页获取产品数据
      * @apiName 分页获取产品数据
      * @apiGroup Product
      * @apiParam {Number} page 页码.
      * @apiParam {Number} number 条数.
      * @apiSuccess (返回值) {Number} 1 {host:"拼接图片的地址",list,page,number,totals}
   **/
   router.get('/',(req,res)=>{})

   生成文档

   在项目根目录下执行：apidoc -i src -o doc

会把src中的所有js文件全走一遍，找到符合的注释项，则编译成文档，存入doc目录中

官网地址：https://apidocjs.com/