環境：

操作系統???CentOS Linux release 7.6.1810 (Core)? 64位

服務器環境???“騰訊云”服務器

?

1，安裝Node.js的npm工具環境：

? ?如有不懂，請看我的博客：CentOS7 源碼編譯安裝NodeJS 最新版本

2，npm環境搭好后，控制臺運行命令：

npm install apidoc -g　　

等待安裝完成?

?

2，新建接口程序文件test.java 中添加apidoc文檔注釋

創建新目錄

mkdir -p /data/apidoc/ cd /data/apidoc/

/data/apidoc目錄新建文件test.java，內容如下：

/*** @apiDefine userApiStr 用戶接口文檔 *//*** @api {POST} /login 用戶登錄* @apiName api測試* @apiGroup userApiStr* @apiVersion 1.0.0* @apiDescription 用于用戶登錄* @apiParam {String} userName 用戶名* @apiParam {String} password 密碼* @apiParamExample {json} 請求樣例：* ?userName=張三&password=11223344* @apiSuccess (200) {String} msg 信息* @apiSuccess (200) {String} code 0 代表無錯誤 1代表有錯誤* @apiSuccess (200) {String} user 用戶信息* @apiSuccess (200) {String} userId 用戶id* @apiSuccessExample {json} 返回樣例:* {"code":"0","msg":"登錄成功","userId":"fe6386d550bd434b8cd994b58c3f8075"}*/

?

? ? 3，生成apidoc文檔，在當前注釋文件目錄下輸入命令

apidoc -i /data/apidoc -o /data/apidoc # apidoc -i 注釋文件所在目錄路徑 生成的apidoc文檔所在目錄路徑

? ? ?

? ? ? 完成后顯示了生成的apidoc文件目錄：

? ? ??

?打開? ”index.html“ 查看生成的接口文檔

? 到這里，apidoc就成功跑起來了

總結

以上是生活随笔為你收集整理的快速根据注释生成接口文档网页工具——Apidoc的使用教程的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。