先简单粗暴一些
首先你得有 nodejs 即打开终端时输入 npm 命令不会告诉你 npm不是内部或外部命令
用 npm 进行安装
npm install apidoc -g
>npm install apidoc -g
C:\Users\cc\AppData\Roaming\npm\apidoc -> C:\Users\cc\AppData\Roaming\npm\node_modules\apidoc\bin\apidoc
+ apidoc@0.17.6
added 41 packages in 11.911s
在项目的根目录下 创建 apidoc.json 文件
也可以去下载， 总之有多种创建方式
apidoc.json 文件的格式内容如下， 你也可以直接创建后复制粘贴过去
{
"name": "写入你想要的名字",
"version": "0.1.0",
"description": "A API Service for resource library.",
"title": "Resource Library API",
"url" : ""
}
然后执行
apidoc -i app/Http/Controllers -o doc/
解析：-i 后面 app/Http/Controllers是你代码所在的文件夹
- -o后面是你的生成的api文档所在的文件夹 我的文件夹名字叫 doc*
执行成功后项目的根目录就多了一个doc文件夹， 打开index.html就是你的文档啦
当然最重要的还是你代码中的注释如要有格式哟
/**
* @api {get} /teacher/test/papers
* @apiDescription 当前教师用户所有的试卷列表
* @apiGroup TeacherTestPaper
* @apiName paper List Of User
* @apiPermission JWT
* @apiVersion 0.1.0
* @apiParam {String} [key] 搜索关键字
* @apiReturn {json}
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
*{
* "status": 200,
* "msg": "success",
* "data": {
}
* }
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 400 Not Found
* {
* "status":400
* " msg":'empty GET'
* }
*/
Shell中输入apidoc -i src/ -o apidoc/命令，如果出现如下图所示的Done结果，则表明文档已经生成，位于同级目录的apidoc（与-o apidoc对应）目录下。
image.png
自己加油悟啊
