编写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