附录A 接口服务文档模板
1、功能说明
// TODO: 请在这里放置简短的接口功能说明。
2、接口服务URL
/?service=接口服务名称 + 公共参数(是否免登录态?)
温馨提示:请将上面的接口服务名称,换成实际的名称。
3、接口服务参数
参数 |
必须 |
默认值 |
说明 |
---|---|---|---|
user_id |
是 |
|
用户id |
group_num |
是 |
|
家庭号 |
4、返回结果
返回字段
参数 |
类型 |
说明 |
---|---|---|
data.code |
int |
结果状态,0表示正常返回 |
group_id |
int |
生成的家庭圈id |
结果示例
{
"ret": 200,
"data": {
"code": 0, // 对操作码进行说明
... ... // 更多字段的说明
"msg": ""
},
"msg": ""
}
请求示例
// TODO: 请放置一个接口请求的链接。