springboot2.7.x版本,怎么使用Swagger
时间: 2024-04-30 09:20:59 浏览: 22
Swagger 是一个接口文档生成工具,可以方便地生成 RESTful API 文档。在 Spring Boot 中,使用 Swagger 也非常简单,只需要添加对应的依赖,然后在配置文件中进行简单的配置即可。
下面是在 Spring Boot 中添加 Swagger 的步骤:
1. 在 pom.xml 文件中添加 Swagger 的依赖:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 在 Spring Boot 的启动类上添加 `@EnableSwagger2` 注解,启用 Swagger:
```
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. 添加 Swagger 配置类,配置 Swagger 的基本信息:
```
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API 文档")
.description("API 接口文档")
.version("1.0.0")
.build();
}
}
```
其中,`@Bean` 注解的 `Docket` 对象是 Swagger 的主要配置对象,可以设置 API 的基本信息,如文档标题、版本号等。`apis` 方法和 `paths` 方法可以设置 API 的扫描范围,这里的示例是扫描 `com.example.demo` 包下的所有 API。
4. 启动应用程序,在浏览器中访问 `http://localhost:8080/swagger-ui.html`,即可看到自动生成的 API 文档。
以上就是在 Spring Boot 中使用 Swagger 的简单步骤,你还可以根据自己的需求进行更加详细的配置。
相关推荐
![zip](https://img-home.csdnimg.cn/images/20210720083736.png)
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)