接口文档编写
接口文档应该还是比较容易写的。
既然是接口那么你就要定义以下的东西：
1、客户端与服务器端交互的网络传输协议，比如http。
2、客户端与服务器端交互的数据格式，比如json
3、你往服务器发送的数据(request)格式、内容。
4、你需要服务器返回给你的数据(response)格式、内容
5、字段说明，你往服务器发的字段是什么意思，服务器返回过来的字段是什么意思。
举一个简单例子，比如一个登录接口，用http,json格式交互，如下：
request:
{
"username ":123456,
"password":"7890"
}
|
序号 |
参数名 |
名称 |
备注 |
|
1 |
username |
用户id |
Long |
|
2 |
password |
密码 |
String |
response:
{
"status":0, //0成功，其它失败。
}
|
序号 |
属性名 |
名称 |
备注 |
|
1 |
status |
登录状态 |
Long |
