apidocWeb API 文檔生成
生成一個(gè)REST風(fēng)格的Web API文檔。
支持的編程語(yǔ)言：
-
C#, Go, Dart, Java, JavaScript, PHP(all DocStyle capable languages)
-
CoffeeScript
-
Erlang
-
Ruby
插件：
apidoc將自動(dòng)包含已安裝的插件。
- apidoc-plugin-schema從api模式生成并注入apidoc元素。
npm install apidoc-plugin-schema
有關(guān)如何實(shí)現(xiàn)自己的插件的詳細(xì)信息和示例，請(qǐng)查看apidoc-plugin-test。
用法：
在源代碼中的任意位置添加一些apidoc注釋?zhuān)?/span>
/ **
* @api {get} / user /：id請(qǐng)求用戶(hù)信息
* @apiName GetUser
* @apiGroup用戶(hù)
*
* @apiParam {Number} id用戶(hù)的唯一ID。
*
* @apiSuccess {String} firstname用戶(hù)的名字。
* @apiSuccess {String}姓氏用戶(hù)的姓氏。
* /
現(xiàn)在生成的文檔src/進(jìn)doc/。
$ apidoc -i src / -o doc /
該存儲(chǔ)庫(kù)包含和example文件夾，您可以從中生成有關(guān)示例api端點(diǎn)的非常完整的文檔。它還包含最佳實(shí)踐提示（在footer.md文件中）。
$ git clone https://github.com/apidoc/apidoc && cd apidoc
$ npm install --prod
$ ./bin/apidoc -i示例-o / tmp / doc
$ $瀏覽器 / tmp / doc
Docker 鏡像
您可以像這樣在Docker中使用apidoc：
＃在克隆此存儲(chǔ)庫(kù)
docker build -t apidoc / apidoc之后首先構(gòu)建映像。
＃運(yùn)行它
docker run --rm -v $（ pwd ）：/ home / node / apidoc apidoc / apidoc -o outputdir -i inputdir
評(píng)論
圖片
表情