apidocWeb API 文档生成
生成一个REST风格的Web API文档。
支持的编程语言：
-
C#, Go, Dart, Java, JavaScript, PHP(all DocStyle capable languages)
-
CoffeeScript
-
Erlang
-
Ruby
插件：
apidoc将自动包含已安装的插件。
- apidoc-plugin-schema从api模式生成并注入apidoc元素。
npm install apidoc-plugin-schema
有关如何实现自己的插件的详细信息和示例，请查看apidoc-plugin-test。
用法：
在源代码中的任意位置添加一些apidoc注释：
/ **
* @api {get} / user /：id请求用户信息
* @apiName GetUser
* @apiGroup用户
*
* @apiParam {Number} id用户的唯一ID。
*
* @apiSuccess {String} firstname用户的名字。
* @apiSuccess {String}姓氏用户的姓氏。
* /
现在生成的文档src/进doc/。
$ apidoc -i src / -o doc /
该存储库包含和example文件夹，您可以从中生成有关示例api端点的非常完整的文档。它还包含最佳实践提示（在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：
＃在克隆此存储库
docker build -t apidoc / apidoc之后首先构建映像。
＃运行它
docker run --rm -v $（ pwd ）：/ home / node / apidoc apidoc / apidoc -o outputdir -i inputdir
评论