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)