接口文档案例

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

案例

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": "成功"
}
相关推荐
lunzi_fly1 分钟前
【源码解读之 Mybatis】【基础篇】-- 第1篇:MyBatis 整体架构设计
java·mybatis
JIngJaneIL17 分钟前
汽车租赁|基于Java+vue的汽车租赁系统(源码+数据库+文档)
java·vue.js·spring boot·汽车·论文·毕设·汽车租赁系统
渣哥32 分钟前
有一天,我和 CopyOnWriteArrayList 杯“线程安全”的咖啡
java
叽哥38 分钟前
Kotlin学习第 3 课:Kotlin 流程控制:掌握逻辑分支与循环的艺术
android·java·kotlin
杨杨杨大侠39 分钟前
第5章:实现Spring Boot集成
java·github·eventbus
华仔啊41 分钟前
工作5年没碰过分布式锁,是我太菜还是公司太稳?网友:太真实了!
java·后端
尚久龙1 小时前
安卓学习 之 图片控件和图片按钮
android·java·学习·手机·android studio·安卓
摸鱼仙人~1 小时前
深入理解 MyBatis-Plus 的 `BaseMapper`
java·开发语言·mybatis
杨杨杨大侠1 小时前
第6章:高级特性与性能优化
java·github·eventbus
Dcs1 小时前
代码评审还能更好!
java