springboot2兼容swagger
时间: 2024-10-01 21:01:53 浏览: 42
Spring Boot 2.x版本默认并不直接包含Swagger(现在通常称为OpenAPI)的集成。但是,你可以通过添加Swagger相关的依赖并配置Swagger UI来轻松地将其整合到Spring Boot应用中。以下是简单的步骤:
1. **添加依赖**:在`pom.xml`或`build.gradle`文件中添加Swagger的starter依赖,例如对于Maven:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0-M5</version> <!-- 最新稳定版 -->
</dependency>
```
2. **配置启动类**:启用Swagger注解支持,如果你使用的是Java Config,可以在`@SpringBootApplication`上添加`@EnableSwagger2`注解。
3. **创建API文档**:使用`@ApiOperation`, `@ApiParam`, `@RequestMapping`等Swagger注解来标记你的RESTful API。
4. **生成UI**:Springfox会自动暴露一个基于Swagger的UI界面,地址通常是`http://localhost:8080/swagger-ui.html`。你也可以自定义路径。
5. **定制UI**:如果需要进一步定制,可以使用Swagger的其他属性进行配置,如主题、标题、描述等。
```java
@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
```
阅读全文