apiDoc在您的源代码中通过创建API注释从而生成api说明文档。

使用方法

我们以express的项目为例

1 创建apidoc.json

{  "name": "abc项目 api 文档",  "version": "1.0.0",  "description": "项目描述",  "title": "abc项目api文档",  "url" : "localhost:3000/api",  "template": {    "withCompare": true,    "withGenerator": true  }}

2 我们在routes文件夹下建立api文件夹，用于书写接口注释说明,例如

/** * @api {get} /news/newsContent 新闻详情 * @apiVersion 1.0.0 * @apiName newsContent * @apiGroup news * @apiParam {Number} id 新闻id * @apiSuccess {Number} code 结果标识 * @apiSuccess {String} message 结果说明 * @apiSuccess {Object} data 结果数据 * @apiSuccessExample Success-Response: *     HTTP/11 200 OK *     { *       "code": 1, *       "mess": "成功", *       "data": {} *     } */

3 调用生成命令

apidoc -i routes/ -o public/apidoc/

以上命令的意思是读取routes文件夹下的api配置，输出api说明文档到public/apidoc/文件夹