springboot3配置swagger2
时间: 2024-10-12 10:04:13 浏览: 28
Spring Boot 3.x版本(目前还未发布,Spring Boot 3.0于2022年12月发布)集成Swagger 2已经相对成熟,但仍可以参考早期版本的做法。以下是基本步骤:
1. 添加依赖:在你的`pom.xml`或`build.gradle`文件中添加Swagger的依赖。对于Maven,你可以用以下内容:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0-M5</version> <!-- 使用最新支持Spring Boot 3的版本 -->
</dependency>
```
或者Gradle:
```groovy
implementation 'io.springfox:springfox-boot-starter:3.0.0-M5'
```
2. 配置启用Swagger:在`application.properties`或`application.yml`中添加Swagger的相关配置,例如:
```yaml
springfox.documentation.swagger2.enabled=true
springfox.documentation.builders.ApiInfo.apiInfo=your-api-info
```
`your-api-info`应包含标题、描述、版本等信息。
3. 创建资源接口文档注解:为需要生成API文档的Controller添加Swagger注解,如`@ApiOperation`和`@ApiResponses`。
4. 定义全局路径前缀:如果你想对所有API操作统一添加URL前缀,可以在`@EnableSwagger2WebMvc`上设置`basePath`属性。
5. 访问Swagger UI:启动应用后,在浏览器访问`http://localhost:8080/swagger-ui.html`即可看到Swagger的UI界面,可以查看和测试你的API文档。
阅读全文