Markdown编写接口文档模版

Posted 2020-11-22 dafengdeai

---

接口名称

1) 请求地址

https://apis.cnblogs.com/user/info?a=xx&b=xx

2) 调用方式：HTTP GET

3) 接口描述：

• 接口描述详情

4) 请求参数:

GET参数:

字段名称	字段说明	类型	必填	备注
a		string	Y	-
b		string	Y	-

5) 请求返回结果:

{
    "errNum": 10001,
    "errMsg": "Param error"
}

6) 请求返回结果参数说明:

字段名称	字段说明	类型	必填	备注
errNum		string	Y	-
errMsg		string	Y	-

END

---

## 接口名称

### 1) 请求地址

>https://apis.cnblogs.com/user/info?a=xx&b=xx

### 2) 调用方式：HTTP post

### 3) 接口描述：

* 接口描述详情

### 4) 请求参数:

#### GET参数:
|字段名称 |字段说明 |类型 |必填 |备注 |
| -------------|:--------------:|:--------------:|:--------------:| ------:|
|a||string|Y|-|
|b||string|Y|-|

### 5) 请求返回结果:

```
{
"errNum": 10001,
"errMsg": "Param Error"
}
```

### 6) 请求返回结果参数说明:
|字段名称 |字段说明 |类型 |必填 |备注 |
| -------------|:--------------:|:--------------:|:--------------:| ------:|
|errNum||string|Y|-|
|errMsg||string|Y|-|