API接口文档的撰写

接口文档：

要写：接口简介、请求参数、返回结果、注意事项。

下面以“喜马拉雅的 ‘圈子’ ”为例子：

接口一

（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方式请求网络数据，相对来说比较安全。

 

转载于:https://www.cnblogs.com/benpaobadaniu/p/4862883.html