接口文档
来源:互联网 发布:python 登录界面 编辑:程序博客网 时间:2024/05/28 20:19
接口文档编写
简单介绍一下,基本内容分为5个部分
1 业务描述:这个接口的作用
2 调用方式以怎样的方式去调用接口(调用方式有多种,每种调用方式最好做个实例)
3 输入参数:调用接口需要哪些参数({参数名 参数类型 参数描述 说明} 传参实例,一般以json格式入参)
4 返回参数:接口返回值(参数名 参数类型参数描述 说明)
5 异常处理:接口调用时经常会出现哪些异常情况,用try捕捉异常
阅读全文
0 0
- 接口文档
- 接口文档
- 接口文档
- 接口文档
- 接口文档
- 接口文档
- 接口文档
- 接口文档
- 接口文档
- 接口模板 接口文档
- Choice接口说明文档
- JNI接口文档
- 支付宝接口文档。
- DSO的接口文档
- 短信WebService接口文档
- 接口文档的核心内容
- wifidog接口文档
- 模板消息接口文档
- 聚类之DBSCAN学习
- 国际化
- 【HDU
- sublime配置C语言和c++编译环境
- Redis有序集合
- 接口文档
- 【Opencv】树莓派配置Opencv 3.2 + Raspicam (一) 系统初始配置 5种方法访问树莓派
- 如何写论文的“引言”部分
- BIOS恢复默认设置后无法进入操作系统的解决办法
- Revit2012免费版64位/32位下载附安装教程
- Leetcode 51 N-Queens
- 二叉树中找到两个节点的最近公共祖先
- MongoDB集群架构及搭建
- 51NOD 1460 连接小岛 「贪心」