以下是一个简单的接口文档模板,您可以将其复制到Word中并根据需要进行修改。
# 接口名称
## 接口描述
这个接口用于...
## 请求URL
```
请求URL
```
## 请求方式
```
请求方式
```
## 请求参数
### Query Params
| 参数名 | 类型 | 是否必须 | 描述 |
| --- | --- | --- | --- |
| param1 | string | 是 | 参数1的描述 |
| param2 | int | 否 | 参数2的描述 |
### Request Body
```
请求体示例
```
| 参数名 | 类型 | 是否必须 | 描述 |
| --- | --- | --- | --- |
| field1 | string | 是 | 字段1的描述 |
| field2 | int | 否 | 字段2的描述 |
## 响应参数
### Response Body
```
响应体示例
```
| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| field1 | string | 字段1的描述 |
| field2 | int | 字段2的描述 |
### Response Headers
| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| header1 | string | 头部1的描述 |
| header2 | int | 头部2的描述 |
## 错误码
| 错误码 | 描述 |
| --- | --- |
| 10001 | 错误码1的描述 |
| 10002 | 错误码2的描述 |
## 版本历史
| 版本号 | 更新日期 | 更新内容 |
| --- | --- | --- |
| v1.0 | 2021-01-01 | 初始版本 |
| v1.1 | 2021-02-01 | 更新内容1,更新内容2 |
## 参考资料
- [参考资料1](链接)
- [参考资料2](链接)