在项目开发测试中,接口文档是贯穿始终的。前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试。接口文档往往以最简单的静态文档的形态存在。然而在紧张的敏捷开发模式下,随着版本迭代,很多接口发生了变化或者被废弃,而开发几乎不会在后期去更新这种静态文档。QA人员阅读“过期”的接口文档是一件痛苦的事情,与开发的沟通成本不降反升。而这些不便于及时维护的静态文档,随着时间的推移最终无人问津。因此,我们想要找到一种长期可维护且轻量便捷的接口文档工具。
平时常用的生成接口文档的工具大多都是Swagger,而Swagger是国外研发的工具,上手较为复杂且繁琐,而且也需要很多代码才能生成,还需要对应的Swagger Editor和SwaggerUI,这两者都需要从Github上下载源码,将其部署到本地Tomcat服务器上,然后通过浏览器访问即可,其他的部署方式也较为繁琐。
而Apipost不用这么麻烦,调试接口或进行API设计的时候自动就直接生成了接口文档,而且数据都实时同步,不用担心需求频繁被修改而文档也需要一直维护,简单好用且容易上手。