Spring Boot集成Swagger接口分类与各元素排序问题

在上一篇中我们完成使用JSR-303校验，以及利用Swagger2得到相关接口文档，这节，我们在原先的基础之上，完成Swagger中关于对各个元素之间控制前后顺序的具体配置方法。

Swagger的接口的分组

首先我们需要对Swagger中的接口也就是以Controller 层作为第一级梯度进行组织的，Controller在我们实际开发中，与其他具体接口之间是存在一对多的关系，我们可以将同属一个模块的接口定义在一个Controller 中，默认情况之下，我们的Swagger 是以Controller为单位，对接口进行分组管理，在Swagger 中，这个分组的元素被称为Tag,但是这里的Tag与接口的关系并不是一对多关系，它支持更加丰富的多对多的关系，

默认的分组

首先通过创建一个简单的例子进，来看一下，我们是如何处理Swagger是如如何根据Controller来组织Tag与接口关系的，定义两个Controller，分别负责教师管理与学生管理接口，为了重复利用代码，我们就在上一篇的基础之上进行代码添加了：
为了简单明了，我均将下列代码放在Application类里边

@RestController
@RequestMapping(value = "/teacher")
static class TeacherController {@GetMapping("/miaow")public String miaow() {return "miaow";}
}@RestController
@RequestMapping(value = "/student")
static class StudentController {@ApiOperation("获取学生清单")@GetMapping("/list")public String bbb() {return "bbb";}@ApiOperation("获取教某个学生的老师清单")@GetMapping("/his-teachers")public String ccc() {return "ccc";}@ApiOperation("创建一个学生")@PostMapping("/aaa")public String aaa() {return "aaa";}
}

此时通过：localhost:8080/swagger-ui.html 访问得到我们Swagger的组织结构是

在这里插入图片描述
在上图中我们了解到我们定义的控制层，得到的swagger生成的默认结构展示出来了。

application.properties文件

swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.x
swagger.version=1.9.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=miaow
swagger.contact.url=https://luoxiaohei520.github.io
swagger.contact.email=miaow@qq.com
swagger.base-package=com.didispace
swagger.base-path=/**swagger.ui-config.tags-sorter=alpha
swagger.ui-config.operations-sorter=alpha

在启动类添加相关控制层接口：

@EnableSwagger2Doc
@SpringBootApplication
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}@Api(tags = {"1-教师管理","3-教学管理"})@RestController@RequestMapping(value = "/teacher")static class TeacherController {@ApiOperation(value = "miaow")@GetMapping("/miaow")public String miaow() {return "miaow";}}@Api(tags = {"2-学生管理"})@RestController@RequestMapping(value = "/student")static class StudentController {@ApiOperation(value = "获取学生清单", tags = "3-教学管理")@GetMapping("/list")public String bbb() {return "bbb";}@ApiOperation("获取教某个学生的老师清单")@GetMapping("/his-teachers")public String ccc() {return "ccc";}@ApiOperation("创建一个学生")@PostMapping("/aaa")public String aaa() {return "aaa";}}
}

得到结果集
在这里插入图片描述

自定义默认分组的名称

@Api(tags = "教师管理")
@RestController
@RequestMapping(value = "/teacher")
static class TeacherController {// ...
}@Api(tags = "学生管理")
@RestController
@RequestMapping(value = "/student")
static class StudentController {// ...
}

我们在Api的tags修改成为我们想要的表达文字：
在这里插入图片描述

合并Controller分组

在此，我们使用了Tag和Controller 一一对应的情况，Swagger中还支持更加灵活的分组！从@Api注解中，我们如果有去看详细代码的时候，发现tags属性其实是一个数组类型。

在这里插入图片描述
因而，我们可以通过地定义同名的Tag来汇总Controller中的相关接口，比如我们可以定义一个Tag为“教学管理“，让这个分组同时包含教师管理和学生管理的所有接口，案例如下：

@Api(tags = {"教师管理", "教学管理"})
@RestController
@RequestMapping(value = "/teacher")
static class TeacherController {// ...
}@Api(tags = {"学生管理", "教学管理"})
@RestController
@RequestMapping(value = "/student")
static class StudentController {// ...
}

更新细粒度的接口分组

通过@Api可以实现将Controller中的接口合并到一个Tag中,但是如果我们希望精确到某个接口的合并，我们应该如何做?

@Api(tags = {"教师管理","教学管理"})
@RestController
@RequestMapping(value = "/teacher")
static class TeacherController {@ApiOperation(value = "maiow")@GetMapping("/miaow")public String miaow() {return "miaow";}}@Api(tags = {"学生管理"})
@RestController
@RequestMapping(value = "/student")
static class StudentController {@ApiOperation(value = "获取学生清单", tags = "教学管理")@GetMapping("/list")public String bbb() {return "bbb";}@ApiOperation("获取教某个学生的老师清单")@GetMapping("/his-teachers")public String ccc() {return "ccc";}@ApiOperation("创建一个学生")@PostMapping("/aaa")public String aaa() {return "aaa";}}

得到效果图：
在这里插入图片描述

内容的顺序

在完成了接口的分组后，我们可以进行对接口内容的展示顺序进行调整，其中，我们主要涉及三个方面：分组的排序、接口的排序、以及参数的排序。

分组排序

关于分组排序，也就是Tag的排序。目前版本的Swagger支持并不太好，通过文档我们可以找到关于Tag排序的配置方法。

第一种，适合原生的Swagger用户，修改：
在这里插入图片描述
第二种方式：Swagger Starter用户，可以通过修改配置的方式：

swagger.ui-config.tags-sorter=alpha

修改上述的配置的源码：

public enum TagsSorter {ALPHA("alpha");private final String value;TagsSorter(String value) {this.value = value;}@JsonValuepublic String getValue() {return value;}public static TagsSorter of(String name) {for (TagsSorter tagsSorter : TagsSorter.values()) {if (tagsSorter.value.equals(name)) {return tagsSorter;}}return null;}
}

我们可以发现Swagger 提供考虑一个选项，就是按照字字母顺序进行排序。

@Api(tags = {"1-教师管理","3-教学管理"})
@RestController
@RequestMapping(value = "/teacher")
static class TeacherController {// ...}@Api(tags = {"2-学生管理"})
@RestController
@RequestMapping(value = "/student")
static class StudentController {@ApiOperation(value = "获取学生清单", tags = "3-教学管理")@GetMapping("/list")public String bbb() {return "bbb";}// ...
}

在这里插入图片描述

接口的排序

在完成了分组排序问题（虽然不太优雅…）之后，在来看看同一分组内各个接口该如何实现排序。同样的，凡事先查文档，可以看到Swagger也提供了相应的配置，下面也分两种配置方式介绍：
第一种还是适合原生Swagger用户的，可以修改：
在这里插入图片描述
第二种：Swagger Starter用户，可以通过修改配置方式：

swagger.ui-config.operations-sorter=alpha

这个配置不像Tag的排序配置没有可选项。它提供了两个配置项：alpha和method，分别代表了按字母表排序以及按方法定义顺序排序。当我们不配置的时候，改配置默认为alpha。

在这里插入图片描述

参数的排序

完成了接口的排序后，更加细粒度的就是请求参数的排序了，在默认的情况下，我们的Swagger会对Model的参数内容展示进行按照字母排序，我们的展示的User在Swagger之前是这样的：

现在，我们希望可以按照Model中定义的成员变量顺序来展示，那么需要我们通过@ApiModelProperty 注解的position参数来实现位置的设置。

对应的User对象如下：
在这里插入图片描述
w未加

@ApiModel(description = "用户实体")
public class User {@ApiModelProperty(value = "用户编号", position = 1)private Long id;@NotNull@Size(min = 2, max = 5)@ApiModelProperty(value = "用户姓名", position = 2)private String name;@NotNull@Max(100)@Min(10)@ApiModelProperty(value = "用户年龄", position = 3)private Integer age;@NotNull@Email@ApiModelProperty(value = "用户邮箱", position = 4)private String email;public Long getId() {return id;}public void setId(Long id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public Integer getAge() {return age;}public void setAge(Integer age) {this.age = age;}public String getEmail() {return email;}public void setEmail(String email) {this.email = email;}public User(Long id, String name, Integer age, String email) {this.id = id;this.name = name;this.age = age;this.email = email;}public User() {}
}

加了Position之后的swagger展示：
在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/119971.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Css3使用

Css3使用

CSS3是CSS（层叠样式表）的最新版本，它引入了许多新特性，使网页设计更加灵活和富有创意。在本文中，我们将介绍CSS3的一些新特性，包括选择器、布局、动画和变形效果。 一、选择器 CSS3引入了一些新的选择器&…
阅读更多...
智能汽车安全：保护车辆远程控制和数据隐私

智能汽车安全：保护车辆远程控制和数据隐私

第一章：引言 智能汽车技术的快速发展为我们带来了许多便利，但也引发了一系列安全和隐私问题。本文将探讨智能汽车安全的重要性，以及如何保护车辆远程控制和数据隐私。 第二章：智能汽车远程控制 智能汽车的远程控制是一项令人兴…
阅读更多...
全球生物气候产品2.5m和30s分辨率

全球生物气候产品2.5m和30s分辨率

简介 生物气候是指生物和气候相互作用的结果，包括植物和动物对气候的影响，以及气候对生物的影响。生物气候研究的是生物、气候、土地和水等自然要素之间相互作用的过程，旨在探讨它们是如何互动并导致生态系统的变化的。生物气候对于理解全球…
阅读更多...
MySQL数据库基本操作1

MySQL数据库基本操作1

文章目录 主要内容一.DDL1.创建表代码如下（示例）: 2.创建表的类型3.其他操作4.修改表结构格式代码如下（示例）: 二.DML1.数据插入代码如下（示例）: 2.数据修改代码如下（示例）: 3.数据删…
阅读更多...
FastAPI 快速学习之 Flask 框架对比

FastAPI 快速学习之 Flask 框架对比

目录 一、前言二、FastAPI 优势三、Hello World四、HTTP 方法五、URL 变量六、查询字符串七、POST 请求八、文件上传九、表单提交十、Cookies十一、模块化视图十二、数据校验十三、自动化文档Swagger 风格ReDoc 风格 十四、CORS跨域 一、前言 本文主要对 FastAPI 与 Flask 框架…
阅读更多...
Qt在Android上设置连接到指定的WIFI

Qt在Android上设置连接到指定的WIFI

在Android上使用Qt设置连接到指定的Wi-Fi网络需要使用Java代码来完成，涉及到Android平台特定的API和权限。接下来下面将会演示如何在Qt中调用Java代码来实现这一功能。 【1】在Qt项目中创建一个名为"AndroidWifiConnector"的Java类。 （新建文件，选择JAVA类型，名字…
阅读更多...
51单片机的PWM控制呼吸灯

51单片机的PWM控制呼吸灯

文章目录 前言一、PWM引脚以及寄存器的配置二、呼吸灯逻辑总结 前言 hello 大家好这里是夏目学长的51单片机课堂，本篇博客是夏目学长观看B站up主学电超人的视频所写的一篇51单片机入门博客之51单片机PWM配置呼吸灯 ，我自己在学习这节课程的时候觉得这节…
阅读更多...
2023.10.26-SQL测试题

2023.10.26-SQL测试题

employee表： department表： job表： location表： 题目及答案： -- (1).查询工资大于一万的员工的姓名(first_name与last_name用“.”进行连接)和工资-- select CONCAT(first_name,.,last_name) as 姓名 ,salary -…
阅读更多...
个人用户免费，亚马逊正式推出 AI 编程服务 CodeWhisperer

个人用户免费，亚马逊正式推出 AI 编程服务 CodeWhisperer

IT 之家 4 月 14 日消息，亚马逊于 2022 年 6 月以预览版的形式，推出了 AI 辅助编程服务 CodeWhisperer。亚马逊于今天宣布该服务正式上线，并免费向个人用户开放。 亚马逊云科技开发者社区为开发者们提供全球的开发技术资源。这里有技术文档、…
阅读更多...
面向对象设计模式——生成器模式

面向对象设计模式——生成器模式

生成器（Builder）设计模式是一种创建型设计模式，用于构建复杂对象。它将对象的构建过程分解成多个步骤，允许你创建不同类型和表示的对象。这种模式的主要目的是将一个对象的构建与其表示分离，从而使相同的构建过程可以创建不同类型的对象。 以下是生成器设计模式的要素和应…
阅读更多...
【计算机网络笔记】Web应用之HTTP协议（涉及HTTP连接类型和HTTP消息格式）

【计算机网络笔记】Web应用之HTTP协议（涉及HTTP连接类型和HTTP消息格式）

系列文章目录 什么是计算机网络？ 什么是网络协议？ 计算机网络的结构 数据交换之电路交换 数据交换之报文交换和分组交换 分组交换 vs 电路交换 计算机网络性能（1）——速率、带宽、延迟 计算机网络性能（2）…
阅读更多...
S5PV210裸机(七):Nand和iNand

S5PV210裸机(七):Nand和iNand

本文主要探讨210Nand和iNand相关知识。 NandFlash 型号与命 K9F2G08：K9F为发行商,2G为Nand大小是2Gbit(256MB),08为Nand是8位(8数据线即接口为8位:传输数据,地址,命令) 功能 Nand是矩阵式存储,每块可存1bit位 …
阅读更多...
FL Studio21.2最新订阅版本更新升级（详细功能介绍）

FL Studio21.2最新订阅版本更新升级（详细功能介绍）

好消息！FL Studio 21.2 在 10 月 26 日正式发布啦，它新增了 FL Cloud 在线采样库和 AI 音乐制作功能，还提供音乐分发到 Spotify、Apple Music 等主要音乐平台的服务。此外，还有新的音频分离功能、自定义波形颜色和新的合成器 Kepl…
阅读更多...
第七节——Vue中定义组件状态驱动视图

第七节——Vue中定义组件状态驱动视图

一、概念 存放当前组件状态的地方&#xff0c;组件所有的状态数据都可以放到data里面存储&#xff0c;在data里定义的数据具备响应式。在组件中data只能是函数。 二、修改data驱动视图 完成点击按钮 num 1功能 <template><div>{{ num }}<button click"…
阅读更多...
Prompt设计与大语言模型微调

Prompt设计与大语言模型微调

本文主要介绍了Prompt设计、大语言模型SFT和LLM在手机天猫AI导购助理项目应用。 ChatGPT基本原理 “会说话的AI”&#xff0c;“智能体” 简单概括成以下几个步骤&#xff1a; 预处理文本&#xff1a;ChatGPT的输入文本需要进行预处理。输入编码&#xff1a;ChatGPT将经过预处理…
阅读更多...
Java实现SQL分页

Java实现SQL分页

在日常开发需要对数据进行分页&#xff0c;配置如下 <!-- baomidou --><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.4.0</version></dependency> 在控…
阅读更多...
C++求欧拉角（eigen库中暴露的一些问题）

C++求欧拉角（eigen库中暴露的一些问题）

不同顺序欧拉角转旋转矩阵对照公式 eigen库求欧拉角公式 分别试验eigen库自带的matrix.eulerAngles()函数&#xff0c;与根据上述公式推导的两种方法求欧拉角 eigen库求得欧拉角的范围一定是 x − > r o l l x->roll x−>roll方向在 [ 0 , π ] [0,π] [0,π]之间&am…
阅读更多...
面试经典150题——Day22

面试经典150题——Day22

文章目录 一、题目二、题解 一、题目 6. Zigzag Conversion The string “PAYPALISHIRING” is written in a zigzag pattern on a given number of rows like this: (you may want to display this pattern in a fixed font for better legibility) P A H N A P L S I I G …
阅读更多...
HarmonyOS 音频通话开发指导

HarmonyOS 音频通话开发指导

常用的音频通话模式包括 VOIP 通话和蜂窝通话。 ● VOIP 通话&#xff1a;VOIP&#xff08;Voice over Internet Protocol&#xff09;通话是指基于互联网协议&#xff08;IP&#xff09;进行通讯的一种语音通话技术。VOIP 通话会将通话信息打包成数据包&#xff0c;通过网络进…
阅读更多...
【算法题】割后面积最大的蛋糕

【算法题】割后面积最大的蛋糕

题目&#xff1a; 矩形蛋糕的高度为 h 且宽度为 w&#xff0c;给你两个整数数组 horizontalCuts 和 verticalCuts&#xff0c;其中&#xff1a; horizontalCuts[i] 是从矩形蛋糕顶部到第 i 个水平切口的距离 verticalCuts[j] 是从矩形蛋糕的左侧到第 j 个竖直切口的距离 请你…
阅读更多...
最新文章

Copyright @ 2022~2023