接口文档案例

接口文档就是后端写给前端，方便前端开发的一个文档。

案例

xxxx接口

xxxx功能

请求url：

POST localhost:8080/xxxx/xxxx/list

请求头：

token: xxxxxxx

请求参数

|------|---------|-----|-----|
| 字段名 | 类型 | 必填 | 描述 |
| page | Integer | 是 | 页数 |
| size | Integer | 是 | 大小 |
| ... | ... | ... | ... |

示例请求体

{
    "page":5,
    "size":10,
    "xxxxx":"111",
    "xxxx":"111",
    "xxx":"111",
    "xxxxxx":"111"
}

返回数据结构

|------|---------|-----|------|
| 字段名 | 类型 | 必填 | 描述 |
| time | String | 否 | 时间 |
| id | Integer | 否 | 主键ID |
| ... | ... | ... | ... |

{
	"data": {
		"list": [
			{
				"time": "2019-01-01",
				"id": 52,
				"name": "张三"
			}
		],
	},
	"code": 0,
	"msg": "成功"
}