Smart-api开源api接口管理平台
17Smart，一起SMART
一、平台简介
1.1、概述
Smart-api是一个极简API管理平台，提供API的”发布&管理”、”数据字典”、”即时沟通”、”文档”、”Mock”和”测试”等功能。
借助此系统，可以避免更多的重复劳动，提高沟通效率、减少API维护成本，且使API更新变动有所历史积累沉淀。通过API多维匿名评分及时发现团队成员问题，帮助其提高绩效。
1.2、特性
- 1、极简：一分钟上手；
- 2、隔离：成员分组、API以项目为维度进行拆分隔离；
- 3、高效：半自动化生成API文档（如愿意在项目引入17smart注解可全自动化）；
- 4、多版本：API可多版本维，变更历史一目了然；
- 5、即时沟通：实时通知、在线沟通；
- 6、在线测试：可自行配置、选择环境测试API（如，测试环境、Mock测试）；
- 7、即时更新：数据字典随数据库表结构实时同步更新展现；
1.3、如何使用
- 1、直接访问由作者维护的http://www.179smart.com/smart-api/(账号：admin@17smart.com；密码：654321)
- 2、自己本地部署（很简单，详见下面“快速部署”）
二、系统介绍
2.1、功能图
2.2、流程图
2.3、架构图
2.4、主要技术
- 1、前端：Jsp + Velocity + jQuery
- 2、后端：Java7 + Springmvc + Websocket + Json
- 3、数据库：Mongodb2.4+
- 4、部署：Tomcat7+ / Springboot
- 5、开发：Maven + Git
三、快速部署
3.1、下载源码
以MyEclipse为例：Import -> Git -> Clone URI -> Next…成功导入工程结构如下：
3.2、配置Mongodb连接
修改src/main/resources目录下系统配置sysConfig.properties文件：
db.mongo.host=192.168.254.18 db.mongo.port=27017 db.mongo.dbName=smartAPI
备注:
- 1、Mongodb官网下载安装很简单；
- 2、无需像Mysql那样的系统初始化Sql；
- 3、dbName可按自己喜欢修改。
3.3、部署
将应用”smart-api”部署在容器如Tomcat下之后，启动后访问如http://192.168.254.50:7070/smart-api即可进入以下界面：
备注：war包、jar包部署都可以.
四、核心操作指南
4.1、注册账号
注册管理员账号如下，注册好后查收邮件，可见密码：
4.2、创建分组
使用注册的管理员账号登录系统，创建用户分组(团队 -> 新建小组)：
4.3、添加用户
使用注册的管理员账号登录系统，创建用户分组(团队 -> 添加新成员)：
4.4、创建项目
主页 -> 新建项目：
4.5、创建模块
主页 -> 新建项目 -> 选择指定项目 -> 添加新模块：
4.6、用户权限
团队 -> 点击知道用户头像：
4.7、系统配置
数据 -> 配置中心：
4.8、发布接口
4.9、测试接口
五、技术交流
5.1、技术群：
- QQ群：582216911
5.2、ISSUES：
- smart-api托管在Github上，如有问题可在 ISSUES 上提问
六、一起Smart的客户
- 人脉通
- 滴滴找布
- 好汽配
- 美业帮
- 人人都是产品经理
- 什马金融
- 传化集团
还在用Word管理接口文档吗？还在拼接URL测试吗？是时候和Word/Excel说再见了！让我们一起SMART~
http://www.179smart.com/smart-api/(账号：admin@17smart.com；密码：654321)
您也想一起smart吗？烦请此处告知。
源码：https://github.com/Aresyi/smart-api