编写 API 文档是 API 编写人员的噩梦,而 API 文档通常是由 API 研发人员编写。因为 API 文档创立繁琐,须要记录的内容比拟广,完结了 API 开发工作后,还要认真编写 API 文档,给研发人员带来额定的工作量。
随着需求量越来越高,工具的诞生让 API 的研发与 API 文档之间的分割更加严密。例如:Swagger、Eolinker、APIdoc、Easydoc 等,这些 API 文档管理工具不仅能够生成丑陋的在线 API 文档,并且反对集成到我的项目主动生成 API 文档。
以 Eolinker 为例,Eolinker 为用户提供了该工具的 OpenAPI,不便用户集成到开发零碎。在每个 API 开发实现后,疾速调用 OpenAPI 并主动生成 API 文档。
当然 OpenAPI 不仅仅是主动新增 API 文档那么简略,Eolinker 还提供了能疾速对系统进行操作的 OpenAPI,可集成到 Jenkins 等集成工具。有了这些 OpenAPI,用户能够利用它们让整个开发流程更加”顺滑”,例如当开发实现触发 OpenAPI 进行测试等。
OpenAPI 只是其中一个实现形式,一些工具则通过配置文件应用依赖的形式集成到开发零碎。例如 Swagger2 就是以这种形式生成的 API 文档,并且 Swagger2 生成 API 的界面同样丑陋、简洁。
团队能够依据我的项目需要去筛选适合的 API 文档工具,若仅对 API 文档有需要,本文提及的四个工具(Swagger、Eolinker、APIdoc、Easydoc)都是不错的抉择。如果思考到我的项目须要优化整个 API 开发流程,并应用工具进行集成,能够抉择一些功能强大,且容易集成到我的项目的 API 管理工具(Eolinker、APIdoc 等)。
演示工具:www.eolinker.com