ApiDoc(通过代码中的注释生成Api文档)使用教程

1.全局安装APIDOC

需要nodejs环境，在项目目录下面使用 npm 安装

 npm install apidoc -g

2.配置一个 apidoc.json 文件，内容如下：

{
"name": "懒人建站",
"version": "1.0.0",
"description": "懒人建站 Api文档",
"title": "懒人建站API V1",
"url" : "http://127.0.0.1:20221/v1",
"sampleUrl" : "http://127.0.0.1:20221/v1"
}

3.配置package.json 添加ApiDoc快捷执行命令

"doc": "apidoc -i app -o apidoc"

{"name": "api","version": "0.1.0","private": true,"scripts": {"doc": "apidoc -i app -o apidoc"}}

注：apidoc -i app -o apidoc 要生成api的文件夹（可以是绝对地址） apidoc是api输出文件夹

4.添加注释，参数解释 参考：

https://apidocjs.com/

5.执行第三步的命令即可生成 api 文档

npm run

注释示例：

/**
* @api {get} /details/:Id 获取用户详情
* @apiName GetUserDetails
* @apiGroup 会员模块
* @apiParam {Number} Id Users unique ID.
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "firstname": "懒人建站",
* "lastname": "Doe1"
* }
*
* @apiError UserNotFound The id of the User was not found.
* @apiErrorExample Error-Response:
* HTTP/1.1 404 Not Found
* {
* "error": "UserNotFound"
* }
*/