api document 文档撰写实例

api文档方便前台调用，大型项目中，写好api documen有事半功倍的效果，推荐使用markdown语法书写：

# **********接口
### A. 功能说明

通过********查询*********。若*****，返回*******。

### B. 接口调用说明
1. 请求URL
> {IP}:{port}/api/v2/member/member/school?appversion=[app版本]&id=[用户的ID]&token=[用户的token]

2. HTTP请求方式
> GET/POST

3. 请求体示例
```
appversion=1.0.1&id=701e53657524450e859d06c9f9844f55d&token=fd94a3876f9043a2a5ec1c6f83b2dbdc

```

4. 请求体字段说明
- appversion, 字符串, 当前app版本
- id, 字符串, 必填, 当前用户的ID
- token, 字符串, 必填, 当前用户的token

5. 返回体示例
- appversion为空时，则返回以下结果
```json
{
"data":{"schools":[]},
"code":0,
"message":""
}
```

- 执行失败，则返回相应的错误信息，如下是执行失败的示例。
```json
{
"data":null,
"code":1000,
"message":"登录失效"
}
```

6. 返回体字段说明
- data, 字符串, 返回体的数据部分
- code, 接口调用的返回值, 0 = 成功
- message, 接口调用提示文本, 调用成功则为空字符串

### C. 接口测试示例
```sql
# 1. 查询目标的id 、token信息
SELECT id, token FROM `member` WHERE nick_name = ' *** '
# id = 701e53657524450e859d06c9f9844f55, token = fd94a3876f9043a2a5ec1c6f83b2dbdc

# 4. 构造请求url
# 192.144.171.172:9096/api/v2/member/member/school?appversion=1.0.1&id=701e53657524450e859d06c9f9844f55&token=fd94a3876f9043a2a5ec1c6f83b2dbdc

# 5. 检查返回值
# {"data":{"schools":[]},"code":0,"message":""}
```

### [返回索引页](../******.md)