接口文档案例

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

案例

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": "成功"
}
相关推荐
pianmian12 小时前
类(JavaBean类)和对象
java
我叫小白菜2 小时前
【Java_EE】单例模式、阻塞队列、线程池、定时器
java·开发语言
Albert Edison3 小时前
【最新版】IntelliJ IDEA 2025 创建 SpringBoot 项目
java·spring boot·intellij-idea
超级小忍3 小时前
JVM 中的垃圾回收算法及垃圾回收器详解
java·jvm
weixin_446122463 小时前
JAVA内存区域划分
java·开发语言·redis
勤奋的小王同学~4 小时前
(javaEE初阶)计算机是如何组成的:CPU基本工作流程 CPU介绍 CPU执行指令的流程 寄存器 程序 进程 进程控制块 线程 线程的执行
java·java-ee
TT哇4 小时前
JavaEE==网站开发
java·redis·java-ee
2401_826097624 小时前
JavaEE-Linux环境部署
java·linux·java-ee
缘来是庄4 小时前
设计模式之访问者模式
java·设计模式·访问者模式
Bug退退退1235 小时前
RabbitMQ 高级特性之死信队列
java·分布式·spring·rabbitmq