Java:接口文档示例

Java:接口文档示例接口文档规范 0 示例代码 1 接口说明 2 接口地址 3 请求方式 4 请求参数 5 响应参数 6 成功示例 7 异常示例 0 示例代码 RestControll RequestMappi user Validatedpub GetMapping page list publicResult Object getPageList UserQueryDTO todo 1 接口说明 Object

0.示例代码

@RestController @RequestMapping("/user") @Validated public class UserController{ 
    @GetMapping("/page-list") public Result<Object> getPageList(UserQueryDTO dto){ 
    //to do... } } 

1.接口说明

根据条件获取用户分页列表

2.接口地址

/user/page-list

3.请求方式

GET

4.请求参数

参数名称 参数类型 参数说明 是否必传 传参示例
page Integer 当前页码,不得小于1 1
pageSize Integer 每页大小,不得小于1 10
name String 用户姓名 大土

5.响应参数

参数名称 参数类型 参数说明 参数示例
code Integer 响应编码 200
message String 响应消息 “ok”
timestamp String 响应时间 “2021-02-03 12:12:12 122”
data Object 响应实体 {“total”:66,“rows”:[“id”:1,“name”:“大土”,“age”:21]}
total Long 数据总量 66
rows List 每页数据集合 [“id”:1,“name”:“大土”,“age”:21]
id Long 用户主键 1
name String 用户姓名 “大土”
age Integer 用户年龄 21

6.成功示例

//请求 http://localhost:8080/user/page-list?page=1&pageSize=10 //响应 { 
    "code": 200, "message": "ok", "timestamp": "2021-02-02 20:38:45 252", "data": { 
    "total": 66, "rows": [ "id": 1, "name": "大土", "age": 21 ] } } 

7.异常示例

//请求 http://localhost:8080/user/page-list //响应 { 
    "code": 400, "message": "parameter can not be null:page", "timestamp": "2021-02-02 20:38:45 252", "data": null } 
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/216635.html原文链接:https://javaforall.net

(0)
上一篇 2026年3月18日 上午11:25
下一篇 2026年3月18日 上午11:25


相关推荐

  • uuid生成方法

    uuid生成方法UUID 生成方法算法原理 UidGenerator 是百度开源的 Java 语言实现 基于 Snowflake 算法的唯一 ID 生成器 而且 它非常适合虚拟环境 比如 Docker 另外 它通过消费未来时间克服了雪花算法的并发限制 UidGenerator 提前生成 ID 并缓存在 RingBuffer 中 压测结果显示 单个实例的 QPS 能超过 6000 000 托管地址 https github com baidu uid generator 依赖环境 JDK8 MySQL 用于分配 WorkerI

    2026年3月20日
    3
  • MATLAB图像处理之图像的均值滤波和中值滤波(附代码)

    MATLAB图像处理之图像的均值滤波和中值滤波(附代码)图像的平滑 锐化都是利用掩模操作来完成的 通过掩模操作实现一种邻域运算 待处理像素点的结果由邻域的图像像素以及相应的与邻域有相同维数的子图像得到 这些子图像被称为滤波器 掩模 核 模板或窗口 掩模运算的数学含义是卷积 或互相关 运算 掩模子图像中的值是系数值 而不是灰度值

    2026年3月18日
    2
  • Swift语言精要 – Dictionary(字典)

    Swift语言精要 – Dictionary(字典)

    2021年6月20日
    106
  • Java证书工具keytool用法总结

    Java证书工具keytool用法总结Keytool 简单介绍 keytool 是个密钥和证书管理工具 它使用户能够管理自己的公钥 私钥对及相关证书 用于 通过数字签名 自我认证 用户向别的用户 服务认证自己 或数据完整性以及认证服务 在 JDK nbsp 1 4 以后的版本中都包含了这一工具 它的位置为 JAVA HOME bin keytool exe keytool 用法说明使用 keytool 工具时可以使用如下命令 各个 JDK 版本

    2026年3月19日
    2
  • windows下彻底关闭nginx服务

    windows下彻底关闭nginx服务windows 下彻底关闭 nginx 服务在 nginx 目录下打开 cmd 窗口运行命令 startnginx 启动 nginx 服务运行命令 nginx sstop 停止 nginx 服务运行命令 nginx sreload 重载配置运行命令 taskkill f t imnginx exe 关闭 nginx 其他服务 这样才能彻底关闭

    2026年3月18日
    2
  • linux系统抓包工具_kali 抓包

    linux系统抓包工具_kali 抓包在使用ECS服务器时,发现网络流量异常,或者发现服务器有异常向外发包行为,可使用抓包工具抓取网络流量包,分析流量包的特征,看看这些流量包来自哪里,或者发向哪里了。根据这些信息,可进一步诊断异常。本文介绍Linux系统,使用tcpdump工具分析流量的方法。TcpDump可将网络中传送的数据包的“头”完全截获下来提供分析。它支持针对网络层、协议、主机、网络或端口的过滤,并提供and、not、or等逻…

    2022年8月21日
    8

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号