【SpringBoot整合系列】SpringBoot3.x整合Swagger

目录

• 产生背景
• 官方解释：
• 作用
• SpringBoot3整合Swagger注意事项
• swagger3 常用注解
• SpringBoot3.x整合Swagger
• • 1.创建工程(jdk:17,boot:3.2.4)
  • 2.引入pom依赖
  • 3.application.yml添加配置
  • 4.添加swagger3.0配置
  • 5.控制器层(Controller)
  • 6.模型层(Model)
  • 7.启动并测试
  • • 【Get请求接口】/swagger/student接口详情
    • Model详情
    • 【POST请求接口】/swagger/student

产生背景

• 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了前后端分离的形态，而且前 端技术和后端技术在各自的道路上越走越远。前端和后端的唯一联系，变成了 API 接口，所以 API 文档 变成了前后端开发人员联系的纽带，变得越来越重要。

• 那么问题来了，随着代码的不断更新，开发人员在开发新的接口或者更新旧的接口后，由于开发任务的 繁重，往往文档很难持续跟着更新，Swagger 就是用来解决该问题的一款重要的工具，对使用接口的人 来说，开发人员不需要给他们提供文档，只要告诉他们一个 Swagger 地址，即可展示在线的 API 接口 文档，除此之外，调用接口的人员还可以在线测试接口数据，同样地，开发人员在开发接口时，同样也 可以利用 Swagger 在线接口文档测试接口数据，这给开发人员提供了便利。

官方解释：

Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，支持从设计和文档到测试和部署的整个API生命周期的开发。Swagger是个于成服务器接的规范性档、并且能够对接进测试的具。

简单来说：Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的web服务。

作用

• 接口的文档在线自动生成
• 功能测试

SpringBoot3整合Swagger注意事项

SpringBoot3+jdk17的情况下，swagger的V2和V3都是不行的。这里使用spring官方出品的springdo