接口文档

一般来说，业务的接口文档包含内容：

1. 接口描述
2. 接口URL
3. 接口参数说明
4. 接口返回值说明
5. 接口实例

---

例如：

1.检查数据是否可用

名称	说明
请求方法	GET
URL	http://blog.csdn.net/user/check/{param}/{type}
参数	jack/1
示例	http://blog.csdn.net/user/check/jack/1
返回值	{   status:200     // 200 成功，201没有查到   msg:“OK”  // 返回信息消息   data:false      // 返回数据true用户已存在，false用户不存在 }

---

2.用户登录

名称	说明
请求方法	POST
参数	u:用户名 必填 p:密码 必填
示例	http://blog.csdn.net/user/login u:jack p:123456
返回值	{   status:200        msg:“OK”    data:“e10adc3949ba59abbe56e057f20f883e” }