首页 > 请教一下大家都用什么来整理API接口?

请教一下大家都用什么来整理API接口?

描述你的问题


想请各位给推荐一份API接口文档的描述和维护方式。

进行过哪些尝试


我一直使用excel来管理各个接口,可是这样存在一些问题:

  1. 有格式的文档不方便做版本控制。

  2. 不方便排版。

所以,先请教各位,api接口大家都用什么来维护呢?


正在关注swagger
有maven plugin可以直接生成文档


目前是swagger,同类的有api blueprint, raml,国内也有用postman做整理的,目前也在摸索api文档,不过我说的3个文档都可以用API transformer互相转换,至于选哪个只有都用过才知道。之所以用标准格式代替excel,因为excel不规范,很难做相关的操作,比如swagger生成的文档可以直接生成前后端接口代码,虽然还有问题,后端模拟测试也可以直接load到swagger ui中,前端测试模拟有swagger server但是只支持rest风格的mock。因为包含信息全,所以如果想生成excel文档自己写代码也完全可以实现,最后把这个文档直接部署到项目中让使用你接口的公司看起来更上档次

【热门文章】
【热门文章】