ubuntu apidoc 使用方案

1,全局安裝

sudo apt install npm

sudo npm install apidoc -g

sudo ln -s /usr/local/nodejs/bin/node /usr/bin/env


2,新建apidoc文件夾

3,創建apidoc.json

{

"name": "apidoc",

"title": "apidoc",

"description":"apidoc遊戲API接口文檔",

"url" : "http://api.demo.com/api.php?",

"version": "1.0.0"

}


4,生產api文檔

sudo apidoc -i ../capi/ -o .


-i 後面是生產文檔的文件

-o 後面是文檔存放的位置,用於訪問


註釋示例:


ubuntu apidoc 使用方案


接口顯示效果


ubuntu apidoc 使用方案


sudo apidoc -i capi/ -o apidoc


分享到:


相關文章: