Web API文档生成工具apidoc

推荐一个api文档生成工具 —— apidoc

apidoc可以根据代码注释生成web api文档,支持大部分主流语言java javascript php coffeescript erlang perl python ruby go…,相对而言,web接口的注释维护起来更加方便,不需要额外再维护一份文档。

apidoc从注释生成静态html网页文档,不仅支持项目版本号,还支持api版本号。

安装

主页: http://apidocjs.com
Github: https://github.com/apidoc/apidoc
可以使用 npm install apidoc -g 进行安装。

1
npm install apidoc -g