API接口文档的撰写
2024-10-20 08:32:59
接口文档：
要写：接口简介、请求参数、返回结果、注意事项。
下面以“喜马拉雅的 ‘圈子’ ”为例子：
接口一
（1）接口简介
http://ipservice.mogujie.com/ipservice?func=feedback&type=serverdelay&ua=android&did=867516022015512&version=7.2.3.150928003
API名称：喜玛朗雅——圈子
功能描述：圈子中的数据，通过 device 的参数得到圈子的参数 id、 title 、createdTime 、content 等数据参数。
数据格式：JSON 格式
请求方式：get
是否需要用户授权：否
请求URL：http://ipservice.mogujie.com/ipservice func=feedback&type=serverdelay&ua=android&did=867516022015512&version=7.2.3.150928003
(2).请求参数
必选参数：
| 参数名 | 类型 | 说明 |
| device | string | 设备名 |
（3）.返回结果
| 参数名 | 类型 | 说明 |
| id | number or long | id |
| zoneld | number | zoneld |
| isTop | bool | 是否置顶 |
| createTime | number | 创建时间 |
| title | string | 标题 |
| content | string | 内容 |
| poster | dictionary | 发送者 |
| poster-(uid) | number | 用户id |
| images | array（dictionary） | 图片 |
（4）注意事项：
图片有可能没有的
（5）请求示例：http://ipservice.mogujie.com/ipservice?func=feedback&type=serverdelay&ua=android&did=867516022015512&version=7.2.3.150928003
（6）示例结果：......
注意：
尽量的多使用POST方式请求网络数据，相对来说比较安全。
最新文章
- java - Stack栈和Heap堆的区别
- Flume
- [POJ1157]LITTLE SHOP OF FLOWERS
- python 中接口的实现
- MST最小生成树及克鲁斯卡尔(Kruskal)算法
- apache rewrite .htaccess 站点内容重定向实例
- xml入门简介--两天学会xml
- BestCoder 2nd Anniversary 1001 Oracle
- canvas绘图基础及基于粒子系统的雪花飘落
- sharepoint rest api 创建文档库 文件夹
- 数据库中有的字段为null时，反馈到页面上是什么也不显示？如何用一个【无】字来代替呢？
- [Swift]LeetCode93. 复原IP地址 | Restore IP Addresses
- Mysql加锁过程详解（5）-innodb 多版本并发控制原理详解
- js实现十分钟内在页面无任何操作，页面跳转至登陆页
- animation渐进实现点点点等待效果
- Visual Studio2017 数据库架构比较
- tomcat启动慢解决方案
- hihoCoder #1037 : 数字三角形 （动态规划）
- Python3基础 list extend 合并列表
- Weblogic12C 集群实现session同步