8.SpringBoot3 整合 Swagger3

由于目前主流的开发模式是前后端分离开发。所以前后端的交互需要通过一个 API（开发接口） 来规范。而这个接口的开发是由后端程序员编写的。“网站式 API 文档”

1.导入依赖

<!-- 引入swagger3(springdoc)的依赖-->
<dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-ui</artifactId><version>2.8.9</version>
</dependency>

2.编写 Swagger3 的配置类

@Configuration
public class SwaggerConfig {@Beanpublic OpenAPI apiConfig() {return new OpenAPI().info(info()).externalDocs(new ExternalDocumentation().description("外部文档").url("https://springshop.wiki.github.org/docs"));}private Info info() {return new Info().title("项目名称").description("项目描述信息").contact(new Contact().name("Touper").url("https://www.itszb.com").email("3245349849@qq.com")).version("1.0");}
}

3.在启动类上开启 swagger 注解开发

4.编写 Controller 方法API

​

5.编写 Controller 方法参数API

1.普通参数

2.复杂参数

其中新增和更新传入的是一个对象，所以他的 API 编写比较特殊。要在实体类里面编写

6.结果展示

7.访问网址

http://localhost:8080/swagger-ui/index.html