先簡單粗暴一些
首先你得有 nodejs 即打開終端時(shí)輸入 npm 命令不會告訴你 npm不是內(nèi)部或外部命令
用 npm 進(jìn)行安裝
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
在項(xiàng)目的根目錄下 創(chuàng)建 apidoc.json 文件
也可以去下載， 總之有多種創(chuàng)建方式
apidoc.json 文件的格式內(nèi)容如下逗柴， 你也可以直接創(chuàng)建后復(fù)制粘貼過去
{
"name": "寫入你想要的名字",
"version": "0.1.0",
"description": "A API Service for resource library.",
"title": "Resource Library API",
"url" : ""
}
然后執(zhí)行
apidoc -i app/Http/Controllers -o doc/
解析：-i 后面 app/Http/Controllers是你代碼所在的文件夾
- -o后面是你的生成的api文檔所在的文件夾 我的文件夾名字叫 doc*
執(zhí)行成功后項(xiàng)目的根目錄就多了一個(gè)doc文件夾笛丙， 打開index.html就是你的文檔啦
當(dāng)然最重要的還是你代碼中的注釋如要有格式喲
/**
* @api {get} /teacher/test/papers
* @apiDescription 當(dāng)前教師用戶所有的試卷列表
* @apiGroup TeacherTestPaper
* @apiName paper List Of User
* @apiPermission JWT
* @apiVersion 0.1.0
* @apiParam {String} [key] 搜索關(guān)鍵字
* @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/命令，如果出現(xiàn)如下圖所示的Done結(jié)果，則表明文檔已經(jīng)生成，位于同級目錄的apidoc（與-o apidoc對應(yīng)）目錄下。
image.png
自己加油悟啊
