为什么要接口管理软件???

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一览无余

  • 这种方式也有明显短板

    1. 没有权限验证
    2. 没有流程化测试用户

    不过对于创业团队来说,上面两点可以忽略吧,效率是关键!

转载于:https://my.oschina.net/jianfengz/blog/1603166

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值