教你写接口需求文档
产品刘
共 2748字,需浏览 6分钟
·
2022-03-17 09:59
一、什么是接口
二、如何设计接口
1. 搞清楚是主动访问还是被动请求:
2. 搞清楚数据交互的实时性要求
3. 选择合适的接口方式
三、如何编写接口文档
1. 如果是向对方系统主动推送数据,则可按以下方式整理接口需求
2. 如果是对方主动来获取数据,则可按以下方式整理接口需求
3. 如果是被动接收对方推送的数据,则可按以下方式整理接口需求
4. 如果主动从对方获取数据,则可按以下方式整理接口需求
点击“阅读原文”
查看更多干货
评论
Mirren-Swagger-API-ManagerAPI 接口文档管理器
MSAM是一个API接口文档管理器,MSAM的属性根据swagger-models-1.5.20.jar进行定义并添加了拓展属性MSAM以项目-接口分组-接口三个单位,项目最终生成的结果理论上兼容Sw
Mirren-Swagger-API-ManagerAPI 接口文档管理器
0
VuzitRubyRuby 文档查看接口
VuzitRuby是一个Ruby库,用来调用VuzitAJAX文档查看器的Web服务接口。它允许开发者上传、加载、删除和查看文档在一个全功能的AJAX阅读器模块。『Vuzit』安全的文档在线浏览工具,
VuzitRubyRuby 文档查看接口
0