接口文档模版（Markdown版）

场景

最近又又又得给第三方系统写接口文档，需要一个Restful接口模版参考参考。

接口文档模版

# ERP 服务

## 监控

### 数据

`POST /system/xxx/getData`

请求参数：

| 字段名     | 类型   | 位置 | 描述                 |
| ---------- | ------ | ---- | -------------------- |
| params| string | body | 父节点     |
| params.beginTime| string | body | 查询开始时间     |
| params.endTime | String    | body |查询结束时间 |

请求示例：

```bash
curl --location --request POST 'http://xxxx/system/xxx/getData' \
--header 'Content-Type: application/json' \
--data-raw '{
    "params": {
        "beginTime": "2021-10-12",
        "endTime": "2021-11-12"
    }
```

响应参数：

| 字段名 | 类型   | 位置 | 描述     |
| ------ | ------ | ---- | -------- |
| code   | Int    | body | 状态码   |
| msg    | string | body | 消息描述 |
| data    | json | body | 返回数据 |
| data.visitorsCount    | Long | body | 访问数 |
| data.registerCount    | Long | body | 注册数 |
| data.providerCount    | Long | body | 服务商数 |

响应示例：

```json
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "visitorsCount": 5, 
        "registerCount": 6, 
        "providerCount": 6  
    }
}
```

总结

上面就是接口文档模版内容。