git 现在基本所有公司都在使用,我们团队的接口管理方式就是基于git,使用markdown编写,没有倾入性,也不需要搭建什么服务器,只需要团队间约定好接口文档格式。
- 定义接口文档格式,如
这个markdown编辑器竟然不支持表格
### 获取聊天室 getChatRoom **入参说明** | 参数 | 类型 | 必填 | 说明 | | ------------- | ------ | ---- | ---------- | | room_id | int | 是 | 聊天室编号 | **出参说明** | 参数 | 类型 | 说明 | | ------- | ---- | -------- | | room_name | string | 聊天室名称 | | room_type | string |聊天室类型 | | room_property | String | 聊天室属性 | | room_head | String | 聊天室头像 |
-
约定好文档存放在各自 git仓库 目录下, 如 doc/api.md
-
写个简单的web服务器,通过配置 可以从各个仓库拉取 文档内容
下图是我们自己的一个简单的接口阅读界面
-
对接口开发来说,写api是必要的工作,写完只需要提交git即可,前端同事刷新接口界面,最新api一览无余
-
这种方式也有明显短板
- 没有权限验证
- 没有流程化测试用户
不过对于创业团队来说,上面两点可以忽略吧,效率是关键!