Metrics
0
Watch 12 Star 36 Fork 9

yunk / auto-ApiPythonGPL-3.0

Sign up for free
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
全自动化API和数据库文档,支持任意语言和框架 spread retract

  • CSS 65.6%
  • Python 21.6%
  • Vue 8.5%
  • Go 3.3%
  • JavaScript 0.6%
  • Other 0.4%
Clone or download
Loading...
README.md

auto-Api

项目介绍

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

优势:
  1. 搭建好后,自动化构建文档,不用再在文档维护上花费更多心力。API服务器软件更新,文档同步更新只用简单点击按钮即可
  2. 高度可定制空间,对特殊的API的开发规格适配比较容易(阅读下wiki)
  3. 使用便捷,安装方便(个鬼,具体的安装方法我自己没在其他机子试过,如果有问题请联系我)。
  4. 作者好联系,有麻烦绝对会出来解决

特性

  • 支持任意语言与框架的服务端程序,构建API文档没有任何侵入代码。
  • 一键式快速构建API文档,一键式更新文档。部署好后不用写一行文档。
  • 高度可定制空间,为不同的API规范留下充足的支持空间
  • 一定程度上比人工文档更加精确和详细,开发人员可以快速理解参数的用途
  • 支持markdown注释,保留人工解释空间。文档内容更加清晰
  • 细化模型高度解耦和形象化,为第三方程序或脚本留下便捷的实现空间
  • 支持 gitlab OAUTH2 授权认证,安全防止文档泄露
  • 支持数据库文档一键生成
  • 使用vue.js + webpack 开发前端界面,响应迅速,无缝体验
  • 支持快速体验,实际使用请求,加深对API的理解

使用界面

2019-1-12更新界面,在之后可能有所变动

  1. 主页 主页

  2. 文档

文档

返回值

相关信息

注释

相关数据库

  1. 支持一键数据库文档生成

数据库

软件架构

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

安装教程

看wiki,不会安装可以联系我 入门安装和配置详细指南

额外的进阶内容

  1. 一些细节可以在这个项目的wiki上看
  2. 数据库代理目前只测试过PostgreSql。要求通讯中不能被加密,这样就能记录某个请求产生的影响

待完成内容

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

参与贡献

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

联系我

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

Comments ( 4 )

You need to Sign in for post a comment

Help Search

Gitee_sixth 5th_float_left_close