博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
为什么要接口管理软件???
阅读量:6440 次
发布时间:2019-06-23

本文共 772 字,大约阅读时间需要 2 分钟。

hot3.png

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

你可能感兴趣的文章
MIT 学生挑战新泽西索取挖矿程序源代码的要求
查看>>
实践 | 不同行业WMS选型策略及需要注意的一些问题
查看>>
MaxCompute与OSS非结构化数据读写互通(及图像处理实例)
查看>>
【F3简介】一张图看懂FPGA-F3实例
查看>>
bash环境(变量与bash配置文件)
查看>>
Server Hard drive mode
查看>>
smb服务器配置过程遇到错误及解决
查看>>
java杂乱
查看>>
在Linux上安装Python3.6.1
查看>>
[基础]iOS 可视化编程(全系列)
查看>>
我的友情链接
查看>>
LVS之NAT模型配置实验
查看>>
nginx 报错 99: Cannot assign requested address
查看>>
几种流行的AJAX框架:jQuery,Mootools,Dojo,Ext JS的对比
查看>>
Socket-Client通信
查看>>
Maven搭建简单的SS项目
查看>>
#我要上首页# 新版博客首页来了,做明星博主还会远吗?
查看>>
PHP缓存技术
查看>>
关于SOCKET资源堆栈
查看>>
笔记 百度搜索
查看>>