生成一个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
-
{ "name": "青蛙快车", "version": "1.0.0", "description": "青蛙快车开发接口文档", "title": "青蛙快车", "url" : "http://www.dunheic.com:8080", "order": [ "Error", "Define", "PostTitleAndError",
-
ApiDoc 参考 前言 ApiDoc 用来比较规范的管理 API 文档。 ApiDoc 这个 API 文档管理器，可以根据你代码的注释来进行自动生成 API 文档。同时支持 C#、Java、JavaScript、PHP、Python等语言。 目录 目录结构1 2 3 4 5 6 7 8 9 10 11 12 13project 项目目录 ├─src 源代码目录 │ ├─commom.php 定义
-
https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统，参考
-
easyopen提供一个简单的api文档查看页面，类似于swagger，基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明，也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示： 左边的树形菜单对应文档名称，点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的，需要
-
CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档，注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境（cabal.debug配置为true）下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =
-
支持在项目中使用 Swagger 注解语法，运行命令，生成 Swagger 文件。 Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。 Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的，和编程语言无关的 API 描述规范。 imi-
-
Django的admindocs应用从模型、视图、模板标签以及模板过滤器中，为任何INSTALLED_APPS中的应用获取文档。并且让文档可以在Django admin中使用。 在某种程度上，你可以使用admindocs来快为你自己的代码生成文档。这个应用的功能十分有限，然而它主要用于文档模板、模板标签和过滤器。例如，需要参数的模型方法在文档中会有意地忽略，因为它们不能从模板中调用。这个应用仍旧有
-
原有插件生成的 HTML 文件内容和格式并不理想，考虑自行调整。 因此 fork 了原有仓库，准备动手修改。 这样就有必要能自己从c的源代码开始编译打包。 参考原有的插件打包说明： https://github.com/skyao/protoc-gen-doc/blob/master/BUILDING.md 准备工作 按照要求，需要准备两个东西： Protocol Buffers library
-
安装 protoc-gen-doc 简单遵循安装要求即可： https://github.com/estan/protoc-gen-doc 安装完成之后的protoc是2.5.0版本，无法处理proto3的文件。因此我们需要升级替换protoc为v3.0.0版本。 升级protoc 使用预编译版本 下载 请先在 protobuf 的 发布页面 中找到对应版本的 download ，然后下载对应版本
-
我正试图从各种类中生成清晰的文档，所有的JAX-RS都有注释，一些用java编写，一些用clojure编写。 我构建了一个maven项目，它只是依赖于包含服务类的war文件： 我无法生成任何服务文档。 当运行mvn发音：docs-X时，我看到我的类“注意到了”： [调试]注意到类 WEB-INF.classes.com.ws.scholar.resources.ClientResource in