API接口文档的撰写
2015-10-09 09:05
267 查看
接口文档:
要写:接口简介、请求参数、返回结果、注意事项。
下面以“喜马拉雅的 ‘圈子’ ”为例子:
接口一
(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).请求参数
必选参数:
(3).返回结果
(4)注意事项:
图片有可能没有的
(5)请求示例:http://ipservice.mogujie.com/ipservice?func=feedback&type=serverdelay&ua=android&did=867516022015512&version=7.2.3.150928003
(6)示例结果:......
接口二
............
尽量的多使用POST方式请求网络数据,相对来说比较安全。
下面提供一篇后台接口文档,写在这里仅供学习研究。
要写:接口简介、请求参数、返回结果、注意事项。
下面以“喜马拉雅的 ‘圈子’ ”为例子:
接口一
(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 | 设备名 |
参数名 | 类型 | 说明 |
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) | 图片 |
图片有可能没有的
(5)请求示例:http://ipservice.mogujie.com/ipservice?func=feedback&type=serverdelay&ua=android&did=867516022015512&version=7.2.3.150928003
(6)示例结果:......
接口二
............
尽量的多使用POST方式请求网络数据,相对来说比较安全。
下面提供一篇后台接口文档,写在这里仅供学习研究。
相关文章推荐
- 第6周、项目3—括号的匹配
- 第6周项目4-数制转换
- iOS分析远程推送的步骤
- 第6周项目1建立顺序栈算法库
- 第六周--项目5后缀表达式
- jQuery Mobile基础08----jQuery Mobile Widgets(2)-navbar(导航
- Struct结构体的使用学习
- 软件测试分类基本概念
- nodeJS压缩图片/JS/CSS
- eclipse中tomcat在debug模式下有时会自动跳转到processWorkerExit(w, completedAbruptly);中的问题
- jQuery的发展史,你知道吗?
- 第四周项目3 单链表应用(3)
- 第六周 项目3-括号的匹配
- 修改产品的group price的值,修改为如下形式: 41.78 => 41.95 55.88 => 55.95
- WampServer下如何实现多域名配置
- 浅入深出的理解了盒模型,哈哈哈
- 勤奋,加快学习进度!
- 第四周项目1 建立单链表
- 项目5 -- 后缀表达式
- jQuery Mobile基础07----jQuery Mobile Widgets(2)-listview(列表视图