采用golang 基于Gin框架编写的在线API文档管理系统;其致力于快速解决团队内部接口文档的编写、维护、存档,以及减少团队协作开发的沟通成本。
- 轻量级
- 架构简单轻巧利于二次开发
- 部署维护方便
- 在MySQL中创建mysql数据库,db.sql导入
- 修改 /config/config.ini 配置文件,修改数据库连接信息
- go get github.com/gongwalker/ApiManager
- go mod vendor
- go build
- 运行 ./run.sh start|grep
- 浏览器打开 http://your_host:8000
- 进入 https://github.com/gongwalker/ApiManager/releases
- 下载 ApiManager-v2.1.0-linux-amd64.zip 并解压
- 进入解压目录,设置数据库(创建数据库,导入db.sql) 与 配置文件(config/config.conf)
- 运行 ./run.sh start|stop
- 进入 https://github.com/gongwalker/ApiManager/releases
- 下载 ApiManager-v2.1.0-windows-amd64.zip 并解压
- 进入解压目录,设置数据库(创建数据库,导入db.sql) 与 配置文件(config/config.conf)
- 进入 https://github.com/gongwalker/ApiManager/releases
- 下载 ApiManager-v2.1.0-mac.zip 并解压
- 进入解压目录,设置数据库(创建数据库,导入db.sql) 与 配置文件(config/config.conf)
- 运行 ./run.sh start|stop
-
系统有三个角色,超级管理、管理员、游客
- 超级管理员 拥用一切权限(api分类管理,api管理)
- 管理 可创建编辑API
- 游客 只能查看接口分类和接口信息 无增删改权限
-
默认的超级管理员 账号root 密码:123456
- 前端页面采用 layui-v2.5.6,Bootstrap v3.3.4,后端采用gin框架编写Restful Api 接口,前后端分离。
- 后端用到了表单校验,权限校验中间件定义,mysql数据存档,项目session可以支持cookie与redis两个储存方案
- 适用于中小团队api文档管理使用
- 可以作为一个基础角手架进行使用,快速开发。初学者可以作为熟悉gin框架学习所用
非常欢迎大家贡献代码,让这个项目成长的更好。