Markdown代码api文档模板
时间: 2023-08-30 15:07:09 浏览: 60
以下是一个简单的Markdown代码API文档模板,你可以根据需要自行修改和添加内容:
# API文档
## 接口名称
接口功能简述。
**接口地址:** `/api/xxx`
**请求方式:** `POST`
### 请求参数
| 参数名 | 必选 | 类型 | 说明 |
| ------ | ---- | ---- | ---- |
| param1 | 是 | string | 参数1说明 |
| param2 | 否 | int | 参数2说明 |
### 请求示例
```
{
"param1": "value1",
"param2": 2
}
```
### 返回参数
| 参数名 | 类型 | 说明 |
| ------ | ---- | ---- |
| code | int | 返回码,0表示成功,其他表示失败 |
| message | string | 返回消息 |
| data | object | 返回数据 |
### 返回示例
```
{
"code": 0,
"message": "成功",
"data": {
"result": "xxx"
}
}
```
## 接口名称2
接口功能简述。
**接口地址:** `/api/yyy`
**请求方式:** `GET`
### 请求参数
| 参数名 | 必选 | 类型 | 说明 |
| ------ | ---- | ---- | ---- |
| param1 | 是 | string | 参数1说明 |
| param2 | 否 | int | 参数2说明 |
### 请求示例
```
/api/yyy?param1=value1¶m2=2
```
### 返回参数
| 参数名 | 类型 | 说明 |
| ------ | ---- | ---- |
| code | int | 返回码,0表示成功,其他表示失败 |
| message | string | 返回消息 |
| data | object | 返回数据 |
### 返回示例
```
{
"code": 0,
"message": "成功",
"data": {
"result": "xxx"
}
}
```
以上是一个简单的Markdown代码API文档模板,你可以根据需要自行修改和添加内容。
相关推荐
![md](https://img-home.csdnimg.cn/images/20210720083646.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)