开源中国 2018 年度最后一场技术盛会邀你来约~错过就要等明年啦!点此立即预约

yunk / auto-ApiPythonGPL-3.0

指数
0
Watch 8 Star 19 Fork 6
加入码云
与超过 300 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
全自动化API文档,支持任意语言和框架 展开 收起

  • CSS 48.4%
  • JavaScript 29.3%
  • Python 10.3%
  • HTML 9.9%
  • Go 2.1%
yedazhi 最后提交于 修改包名
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md

auto-Api

项目介绍

如果你在为API文档的编写的繁琐而烦恼?

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

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

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

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

使用界面

随着版本迭代,以下界面可能有稍微的区别,但核心功能基本不变。只有大变动,我才会更新图片

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

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

请求参数自动与数据表关联 请求参数

返回值

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

4.提供搜索API功能 搜索结果

  1. 自动检测API影响到的数据库 数据库

  2. 自动高亮不同请求导致的sql 语句不同的部分 自动高亮

  3. 支持通过以往的请求记录,快速试验API的效果 快速试验

软件架构

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

安装教程

  1. 克隆本项目到服务器上
  2. 用pip3安装些必要的包pip install -r requirements.txt
  3. 打开proxy.conf进行配置,配置说明在这个文件里有说明(理解了软件架构,应该了解怎么配置)
  4. python3 proxy.py启动代理,进行监听
  5. go run db_proxy/main.go 启动数据库代理 # 可选的,刚开始可以无视
  6. python3 web_console.py 启动web界面服务端程序
  7. 到这里就可以打开 http://localhost:9001 开始使用了 详细安装方法可以查看入门安装和配置详细指南

额外的进阶内容

  1. 目前项目没有登陆和后台管理系统之类的东西,限制查看人员,只有一个gitlab 的oauth2 的验证
  2. 一些细节可以在这个项目的wiki上看
  3. 数据库代理目前只测试过PostgreSql。要求通讯中不能被加密,这样就能记录某个请求产生的影响

待完成内容

看issue吧,有需要的功能也可以开个新的issue

参与贡献

  1. 提Issue 把使用中遇到的问题告诉我
  2. 点个star 让我开心下
  3. 提PR,这就厉害了,非常感谢。

从哪里开始

  1. 如果要阅读和修改代码,可以从web_console.py这个文件开始,这是web服务的实现脚本(全部堆这里了)
  2. proxy.py 是代理脚本,如果发现什么bug,欢迎提PR(自己撸的简单反向代理)
  3. 自动化理解API算法,在solvers.py 下面,目前还不是很建议读,我要把相关的实现文档写下会好读些
  4. 提交PR之前不要将proxy.conf 的修改commit ,用git update-index --assume-unchanged proxy.conf

联系我

有任何使用问题,都可以联系我 QQ群:604437106 自动化文档

项目点评 ( 6 )

你可以在登录后,发表评论

搜索帮助