生成一个REST风格的WebAPI文档。
支持的编程语言：
C#,Go,Dart,Java,JavaScript,PHP(allDocStylecapablelanguages)
CoffeeScript
Erlang
Ruby
插件：apidoc将自动包含已安装的插件。apidoc-plugin-schema从api模式生成并注入apidoc元素。npminstallapidoc-plugin-schema有关如何实现自己的插件的详细信息和示例，请查看apidoc-plugin-test。用法：在源代码中的任意位置添加一些apidoc注释：/***@api{get}/user/：id请求用户信息*@apiNameGetUser*@apiGroup用户**@apiParam{Number}id用户的唯一ID。**@apiSuccess{String}firstname用户的名字。*@apiSuccess{String}姓氏用户的姓氏。*/现在生成的文档src/进doc/。$apidoc-isrc/-odoc/该存储库包含和example文件夹，您可以从中生成有关示例api端点的非常完整的文档。它还包含最佳实践提示（在footer.md文件中）。$gitclonehttps://github.com/apidoc/apidoc&&cdapidoc$npminstall--prod$./bin/apidoc-i示例-o/tmp/doc$$浏览器/tmp/doc Docker镜像您可以像这样在Docker中使用apidoc：＃在克隆此存储库dockerbuild-tapidoc/apidoc之后首先构建映像。＃运行它dockerrun--rm-v$（pwd）：/home/node/apidocapidoc/apidoc-ooutputdir-iinputdir
评论