1-3年的Java开发工程师看过来,Spring Boot 2(5)

@GetMapping(“/list”)

public String bbb() {

return “bbb”;

}

@ApiOperation(“获取教某个学生的老师清单”)

@GetMapping(“/his-teachers”)

public String ccc() {

return “ccc”;

}

@ApiOperation(“创建一个学生”)

@PostMapping(“/aaa”)

public String aaa() {

return “aaa”;

}

}

启动应用之后,我们可以看到Swagger中这两个Controller是这样组织的:

图中标出了Swagger默认生成的Tag与Spring Boot中Controller展示的内容与位置。

自定义默认分组的名称

接着,我们可以再试一下,通过@Api注解来自定义Tag,比如这样:

@Api(tags = “教师管理”)

@RestController

@RequestMapping(value = “/teacher”)

static class TeacherController {

// …

}

@Api(tags = “学生管理”)

@RestController

@RequestMapping(value = “/student”)

static class StudentController {

// …

}

再次启动应用之后,我们就看到了如下的分组内容,代码中@Api定义的tags内容替代了默认产生的teacher-controllerstudent-controller

合并Controller分组

到这里,我们还都只是使用了TagController一一对应的情况,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中,但是如果我们希望精确到某个接口的合并呢?比如这样的需求:“教学管理”包含“教师管理”中所有接口以及“学生管理”管理中的“获取学生清单”接口(不是全部接口)。

那么上面的实现方式就无法满足了。这时候发,我们可以通过使用@ApiOperation注解中的tags属性做更细粒度的接口分类定义,比如上面的需求就可以这样子写:

@Api(tags = {“教师管理”,“教学管理”})

@RestController

@RequestMapping(value = “/teacher”)

static class TeacherController {

@ApiOperation(value = “xxx”)

@GetMapping(“/xxx”)

public String xxx() {

return “xxx”;

}

}

@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用户,可以通过如下方式:

file

第二种:Swagger Starter用户,可以通过修改配置的方式:

swagger.ui-config.tags-sorter=alpha

似乎找到了希望,但是其实这块并没有什么可选项,一看源码便知:

public enum TagsSorter {

ALPHA(“alpha”);

private final String value;

TagsSorter(String value) {

this.value = value;

}

@JsonValue

public 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只提供了一个选项,就是按字母顺序排列。那么我们要如何实现排序呢?这里笔者给一个不需要扩展源码,仅依靠使用方式的定义来实现排序的建议:为Tag的命名做编号。比如:

@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也提供了相应的配置,下面也分两种配置方式介绍:

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)

img

总结

至此,文章终于到了尾声。总结一下,我们谈论了简历制作过程中需要注意的以下三个部分,并分别给出了一些建议:

  1. 技术能力:先写岗位所需能力,再写加分能力,不要写无关能力;
  2. 项目经历:只写明星项目,描述遵循 STAR 法则;
  3. 简历印象:简历遵循三大原则:清晰,简短,必要,要有的放矢,不要海投;

以及最后为大家准备的福利时间:简历模板+Java面试题+热门技术系列教程视频

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

总结

至此,文章终于到了尾声。总结一下,我们谈论了简历制作过程中需要注意的以下三个部分,并分别给出了一些建议:

  1. 技术能力:先写岗位所需能力,再写加分能力,不要写无关能力;
  2. 项目经历:只写明星项目,描述遵循 STAR 法则;
  3. 简历印象:简历遵循三大原则:清晰,简短,必要,要有的放矢,不要海投;

以及最后为大家准备的福利时间:简历模板+Java面试题+热门技术系列教程视频

[外链图片转存中…(img-aWUQ9HTN-1713272579651)]

[外链图片转存中…(img-wgfaRedr-1713272579651)]

[外链图片转存中…(img-SI81iWC1-1713272579651)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值