Swagger
官网地址:https://swagger.io Swagger 是一款RESTFUL接口的文档在线自动天生+功能测试功能软件,是一个规范和完全的框架,标准的,措辞无关,用于天生、描述、调用和可视化 RESTful 风格的 Web 做事。总体目标是使客户端和文件系统作为做事器以同样的速率来更新。文件的方法,参数和模型紧密集成到做事器真个代码,许可API来始终保持同步。Swagger 让支配管理和利用功能强大的API从未如此大略。
目前最新版本是V3,SwaggerUI是一个大略的Restful API 测试和文档工具。大略、俊秀、易用。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以险些放在任何Web容器上利用。

RAP
官网地址:http://rapapi.org/org/index.do
RAP来自阿里巴巴,是一个可视化接口管理工具 通过剖析接口构造,利用mock动态天生仿照数据,校验真实接口精确性, 环绕接口定义,通过一系列自动化工具提升我们的协作效率。可以在线利用,也可以选择本地支配。一个GUI的WEB接口管理工具。在RAP中,您可定义接口的URL、要求&相应细节格式等等。通过剖析这些数据,RAP供应MOCK做事、测试做事等自动化工具。RAP同时供应大量企业级功能,帮助企业和团队高效的事情。
在前后端分离的开拓模式下,我们常日须要定义一份接口文档来规范接口的详细信息。如一个要求的地址、有几个参数、参数名称及类型含义等等。RAP 首先方便团队录入、查看和管理这些接口文档,并通过剖析构造化的文档数据,重复利用并天生自测数据、供应自测掌握台等等... 大幅度提升开拓效率。
APIDOC
GitHub 地址:https://github.com/apidoc/apidoc
APIDOC可以根据代码注释天生WEB API文档,支持大部分主流开拓措辞,Java、javascript、php、erlang、perl、python、ruby等等,相对而言,web接口的注释掩护起来更加方便,不须要额外再掩护一份文档。APIDOC从注释天生静态html网页文档,不仅支持项目版本号,还支持API版本号。
操作步骤也是相称大略,依据官网的操作指南完成一个大略的示例。这是一个示例demo,感想熏染一下http://apidocjs.com/example_basic/
Spring REST Docs
官网地址:http://projects.spring.io/spring-restdocs/
Spring的文档帮助产生RESTful的做事文档。它结合了手写文档写的asciidoctor和自动天生与Spring MVC测试天生的片段。这种方法可以让你打破Swagger那样的工具产生的文件的局限性。它可以帮助你制作文件,准确,简洁,构造良好。天生的文档,可以让你的用户得到一个最低限度的他们所须要的信息。
其它
除了上面先容到一些开源或免费的API管理工具,国内外同样也有一些公司在做这个事情,根据利用需求做好选型即可,适宜自己的才是最好的。