接口文档案例

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

案例

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": "成功"
}
相关推荐
卡尔特斯38 分钟前
Android Kotlin 项目代理配置【详细步骤(可选)】
android·java·kotlin
白鲸开源39 分钟前
Ubuntu 22 下 DolphinScheduler 3.x 伪集群部署实录
java·ubuntu·开源
ytadpole1 小时前
Java 25 新特性 更简洁、更高效、更现代
java·后端
纪莫1 小时前
A公司一面:类加载的过程是怎么样的? 双亲委派的优点和缺点? 产生fullGC的情况有哪些? spring的动态代理有哪些?区别是什么? 如何排查CPU使用率过高?
java·java面试⑧股
JavaGuide2 小时前
JDK 25(长期支持版) 发布,新特性解读!
java·后端
用户3721574261352 小时前
Java 轻松批量替换 Word 文档文字内容
java
白鲸开源2 小时前
教你数分钟内创建并运行一个 DolphinScheduler Workflow!
java
Java中文社群3 小时前
有点意思!Java8后最有用新特性排行榜!
java·后端·面试
代码匠心3 小时前
从零开始学Flink:数据源
java·大数据·后端·flink
间彧3 小时前
Spring Boot项目中如何自定义线程池
java