接口文档案例

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

案例

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": "成功"
}
相关推荐
拼搏@1 小时前
第十六天,7月10日,八股
java·mybatis
Sylvia-girl5 小时前
Java——抽象类
java·开发语言
Touper.8 小时前
Redis 基础详细介绍(Redis简单介绍,命令行客户端,Redis 命令,Java客户端)
java·数据库·redis
m0_535064608 小时前
C++模版编程:类模版与继承
java·jvm·c++
虾条_花吹雪9 小时前
Using Spring for Apache Pulsar:Message Production
java·ai·中间件
tomorrow.hello9 小时前
Java并发测试工具
java·开发语言·测试工具
Moso_Rx9 小时前
javaEE——synchronized关键字
java·java-ee
张小洛9 小时前
Spring AOP 是如何生效的(入口源码级解析)?
java·后端·spring
DKPT9 小时前
Java设计模式之行为型模式(观察者模式)介绍与说明
java·笔记·学习·观察者模式·设计模式
追风少年浪子彦10 小时前
mapstruct与lombok冲突原因及解决方案
java·spring boot·spring·spring cloud