Spring Boot 整合 Swagger3 如何生成接口文档？

二、Application上面加入@EnableOpenApi注解

====================================================================================================

@EnableOpenApi

@SpringBootApplication

@MapperScan(basePackages = {“cn.ruiyeclub.dao”})

public class Swagger3Application {

public static void main(String[] args) {

SpringApplication.run(Swagger3Application.class, args);

}

}

三、Swagger3Config的配置

======================================================================================

@Configuration

public class Swagger3Config {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.OAS_30)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title(“Swagger3接口文档”)

.description(“更多请咨询服务开发者Ray。”)

.contact(new Contact(“Ray。”, “http://www.ruiyeclub.cn”, “ruiyeclub@foxmail.com”))

.version(“1.0”)

.build();

}

}

四、Swagger注解的使用说明

===================================================================================

@Api：用在请求的类上，表示对类的说明

tags=“说明该类的作用，可以在UI界面上看到的注解”

value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”

@ApiOperation：用在请求的方法上，说明方法的用途、作用

value=“说明方法的用途、作用”

notes=“方法的备注说明”

@ApiImplicitParams：用在请求的方法上，表示一组参数说明

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

name：参数名

value：参数的汉字说明、解释

required：参数是否必须传

paramType：参数放在哪个地方

· header --> 请求参数的获取：@RequestHeader

· query --> 请求参数的获取：@RequestParam

· path（用于restful接口）–> 请求参数的获取：@PathVariable

· body（不常用）

· form（不常用）

dataType：参数类型，默认String，其它值dataType=“Integer”

defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

code：数字，例如400

message：信息，例如"请求参数没填好"

response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息

（这种一般用在post创建的时候，使用@RequestBody这样的场景，

请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：用在属性上，描述响应类的属性

Controller层的配置：

@Api(tags = “用户信息管理”)

@RestController

@RequestMapping(“userRecord”)

public class UserRecordController extends ApiController {

/**

• 服务对象

*/

@Resource

private UserRecordService userRecordService;

/**

• 分页查询所有数据

• @param page 分页对象

• @param userRecord 查询实体

• @return 所有数据

*/

@ApiOperation(“分页查询所有数据”)

@GetMapping(“page”)

public R selectAll(Page page, UserRecord userRecord) {

return success(this.userRecordService.page(page, new QueryWrapper<>(userRecord)));

}

/**

• 通过主键查询单条数据

• @param id 主键

• @return 单条数据

*/

@ApiOperation(“通过主键查询单条数据”)

@GetMapping(“{id}”)

public R selectOne(@PathVariable Serializable id) {

return success(this.userRecordService.getById(id));

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

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

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

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

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

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

最后

现在正是金三银四的春招高潮，前阵子小编一直在搭建自己的网站，并整理了全套的**【一线互联网大厂Java核心面试题库+解析】：包括Java基础、异常、集合、并发编程、JVM、Spring全家桶、MyBatis、Redis、数据库、中间件MQ、Dubbo、Linux、Tomcat、ZooKeeper、Netty等等**

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
：包括Java基础、异常、集合、并发编程、JVM、Spring全家桶、MyBatis、Redis、数据库、中间件MQ、Dubbo、Linux、Tomcat、ZooKeeper、Netty等等**

[外链图片转存中…(img-tt2Pq2Am-1713293470187)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！