SpringBoot3使用openapi
时间: 2023-09-22 12:15:03 浏览: 331
Spring Boot使用OpenAPI(也称为Swagger3)的步骤如下:
1. 首先,你需要导入Swagger3的依赖。在你的项目中的pom.xml文件中添加以下依赖项:
```
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.12</version>
</dependency>
```
2. 如果你的Spring Boot版本高于2.4或2.5,你需要在application.yml配置文件中增加mvc配置,以启用Swagger的接口文档生成。例如:
```
springdoc:
api-docs:
enabled: true
```
3. 定义一个Swagger的配置类,用于配置Swagger的各项参数,比如文档标题、版本等。你可以通过继承`org.springdoc.core.SpringDocConfigurat`类或者使用`@Configuration`注解创建一个配置类。在配置类中,你可以使用`@Bean`注解配置Swagger的各种参数,如下所示:
```
@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info().title("API Documentation").version("1.0.0"));
}
}
```
4. 现在你可以开始使用OpenAPI了。在你的Controller类或者方法上使用Swagger的注解,比如`@Operation`、`@Api`等来描述接口信息。这些注解将会被Swagger自动解析生成接口文档。
在你的浏览器中访问启动的Spring Boot应用程序的Swagger UI页面,通常是`http://localhost:8080/swagger-ui.html`,你将看到自动生成的接口文档。
以上就是Spring Boot中使用OpenAPI(Swagger3)的基本步骤。通过配置Swagger的注解和参数,你可以更详细地定义和展示你的API接口信息。如果你需要进一步了解示例代码和其他配置说明,你可以参考提供的Spring Boot与SpringDoc OpenAPI3整合的Demo代码。
阅读全文
相关推荐


















