0
点赞
收藏
分享

微信扫一扫

记录一个Markdown编写的接口文档模版

拾杨梅记 2022-03-11 阅读 85
后端

接口名称

1) 请求地址

2) 调用方式:HTTP post

3) 接口描述:

  • 接口描述详情

4) 请求参数:

GET参数:

字段名称字段说明类型必填备注
astrY-
bstrY-

5) 请求返回结果:

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

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

字段名称字段说明类型备注
astr-
bstr-
## 接口名称

### 1) 请求地址

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

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

### 3) 接口描述:

* 接口描述详情

### 4) 请求参数:

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

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

#```去掉#号
{
"errNum": 10001,
"errMsg": "Param Error"
}
#```

### 6) 请求返回结果参数说明:
|  字段名称   | 字段说明 | 类型 | 备注 |
|  ----  | ----  | ---- |----  |
| a  |  | str | - | 
| b  |  | str | - |
举报

相关推荐

0 条评论