SpringBoot整合Swagger2，再也不用维护接口文档了！

Java小猿。

于 2024-03-31 03:01:10 发布

阅读量628

点赞数 14

分类专栏：程序员文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/H1767410/article/details/137189465

版权

程序员专栏收录该内容

701 篇文章 0 订阅

订阅专栏

.apis(RequestHandlerSelectors.basePackage(“com.nvn.controller”))

.paths(PathSelectors.any())

.build().apiInfo(new ApiInfoBuilder()

.title(“SpringBoot整合Swagger”)

.description(“SpringBoot整合Swagger，详细信息…”)

.version(“9.0”)

.contact(new Contact(“啊啊啊啊”,“blog.csdn.net”,“aaa@gmail.com”))

.license(“The Apache License”)

.licenseUrl(“http://www.baidu.com”)

.build());

}

这里提供一个配置类，首先通过@EnableSwagger2注解启用Swagger2，然后配置一个Docket Bean，这个Bean中，配置映射路径和要扫描的接口的位置，在apiInfo中，主要配置一下Swagger2文档网站的信息，例如网站的title，网站的描述，联系人的信息，使用的协议等等。

如此，Swagger2就算配置成功了，非常方便。

此时启动项目，输入http://localhost:8080/swagger-ui.html，能够看到如下页面，说明已经配置成功了：

在这里插入图片描述

创建接口

接下来就是创建接口了，Swagger2相关的注解其实并不多，而且很容易懂，下面我来分别向小伙伴们举例说明：

@RestController

@Api(tags = “用户管理相关接口”)

@RequestMapping(“/user”)

public class UserController {

@PostMapping(“/”)

@ApiOperation(“添加用户的接口”)

@ApiImplicitParams({

@ApiImplicitParam(name = “username”, value = “用户名”, defaultValue = “李四”),

@ApiImplicitParam(name = “address”, value = “用户地址”, defaultValue = “深圳”, required = true)

}

)

public RespBean addUser(String username, @RequestParam(required = true) String address) {

return new RespBean();

}

@GetMapping(“/”)

@ApiOperation(“根据id查询用户的接口”)

@ApiImplicitParam(name = “id”, value = “用户id”, defaultValue = “99”, required = true)

public User getUserById(@PathVariable Integer id) {

User user = new User();

user.setId(id);

return user;

}

@PutMapping(“/{id}”)

@ApiOperation(“根据id更新用户的接口”)

public User updateUserById(@RequestBody User user) {

return user;

}

这里边涉及到多个API，我来向小伙伴们分别说明：

@Api注解可以用来标记当前Controller的功能。
@ApiOperation注解用来标记一个方法的作用。
@ApiImplicitParam注解用来描述一个参数，可以配置参数的中文含义，也可以给参数设置默认值，这样在接口测试的时候可以避免手动输入。
如果有多个参数，则需要使用多个@ApiImplicitParam注解来描述，多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。
需要注意的是，@ApiImplicitParam注解中虽然可以指定参数是必填的，但是却不能代替@RequestParam(required = true)，前者的必填只是在Swagger2框架内必填，抛弃了Swagger2，这个限制就没用了，所以假如开发者需要指定一个参数必填，@RequestParam(required = true)注解还是不能省略。
如果参数是一个对象（例如上文的更新接口），对于参数的描述也可以放在实体类中。例如下面一段代码：

@ApiModel

public class User {

@ApiModelProperty(value = “用户id”)

private Integer id;

@ApiModelProperty(value = “用户名”)

private String username;

@ApiModelProperty(value = “用户地址”)

private String address;

//getter/setter

}

好了，经过如上配置之后，接下来，刷新刚刚打开的页面，可以看到如下效果：

在这里插入图片描述

可以看到，所有的接口这里都列出来了，包括接口请求方式，接口地址以及接口的名字等，点开一个接口，可以看到如下信息：

在这里插入图片描述

可以看到，接口的参数，参数要求，参数默认值等等统统都展示出来了，参数类型下的query表示参数以key/value的形式传递，点击右上角的Try it out，就可以进行接口测试：

在这里插入图片描述

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

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

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

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

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

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

既已说到spring cloud alibaba，那对于整个微服务架构，如果想要进一步地向上提升自己，到底应该掌握哪些核心技能呢？

就个人而言，对于整个微服务架构，像RPC、Dubbo、Spring Boot、Spring Cloud Alibaba、Docker、kubernetes、Spring Cloud Netflix、Service Mesh等这些都是最最核心的知识，架构师必经之路！下图，是自绘的微服务架构路线体系大纲，如果有还不知道自己该掌握些啥技术的朋友，可根据小编手绘的大纲进行一个参考。

如果觉得图片不够清晰，也可来找小编分享原件的xmind文档！

且除此份微服务体系大纲外，我也有整理与其每个专题核心知识点对应的最强学习笔记：

出神入化——SpringCloudAlibaba.pdf
SpringCloud微服务架构笔记（一）.pdf
SpringCloud微服务架构笔记（二）.pdf
SpringCloud微服务架构笔记（三）.pdf
SpringCloud微服务架构笔记（四）.pdf
Dubbo框架RPC实现原理.pdf
Dubbo最新全面深度解读.pdf
Spring Boot学习教程.pdf
SpringBoo核心宝典.pdf
第一本Docker书-完整版.pdf
使用SpringCloud和Docker实战微服务.pdf
K8S(kubernetes)学习指南.pdf

另外，如果不知道从何下手开始学习呢，小编这边也有对每个微服务的核心知识点手绘了其对应的知识架构体系大纲，不过全是导出的xmind文件，全部的源文件也都在此！

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
-3hyV0YiQ-1711825231796)]

[外链图片转存中…(img-t7FvsdgI-1711825231796)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！

Java小猿。

关注

14
点赞
踩
24

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot整合Swagger2，再也不用维护接口文档了！

既已说到spring cloud alibaba，那对于整个微服务架构，如果想要进一步地向上提升自己，到底应该掌握哪些核心技能呢？就个人而言，对于整个微服务架构，像RPC、Dubbo、Spring Boot、Spring Cloud Alibaba、Docker、kubernetes、Spring Cloud Netflix、Service Mesh等这些都是最最核心的知识，架构师必经之路！下图，是自绘的微服务架构路线体系大纲，如果有还不知道自己该掌握些啥技术的朋友，可根据小编手绘的大纲进行一个参考。
复制链接

扫一扫