全自动化API文档和测试,支持任意语言和框架

项目介绍

如果你在为API文档的编写和测试的繁琐而烦恼,那么这个项目你可算找对了。

全自动化API文档和测试,支持任意语言和框架。解放生产力,不用再为文档更新的不及时和测试用例的编写而烦恼。

一键自动化快速生成文档,检查文档的内容和自己的API的意图是否一致,快速定位设计缺陷。

应用开发者再也不会因为文档错误找你麻烦了

优势:

  1. 搭建好后,自动化构建文档,不用再在文档维护上花费更多心力。API服务器软件更新,文档同步更新只用简单点击按钮即可
  2. 高度可定制空间,对特殊的API的开发规格适配比较容易(阅读下wiki)
  3. 使用便捷,安装方便(出现问题可以找我)。通过图形界面就可以做出足够的操作
  4. 作者好联系,有麻烦绝对会出来解决

缺陷:

  1. 因为项目目前只有一个人开发,所以可能会有问题,但联系我讨论项目相关的问题,我都会在的
  2. 目前只支持 json 格式的返回值分析,xml或者其他格式的支持也不困难。有需要可以提issue
  3. 必须要是被请求过的API才会自动构建文档。这也应该算不上什么大问题,因为服务端开发肯定是要测试的,开发者的测试请求被拦截,自然可以构建出文档。

使用界面

全自动化API文档和测试,支持任意语言和框架

自动构建文档,只要点下按钮,等待一会。文档就会自动构建

全自动化API文档和测试,支持任意语言和框架

点击左边的API列表,就能看到文档内容

全自动化API文档和测试,支持任意语言和框架

一些无法简单通过代理归纳的问题,需要通过其他方式实现自动化理解,有些则必须要人工。比如API的用途说

软件架构

绿色的是主体程序,黄色的是可选的部分(涉及一些API自动理解的计算,刚开始可以不用管)

全自动化API文档和测试,支持任意语言和框架

项目地址

https://gitee.com/easyGroup/auto-Api

相关推荐