一篇搞定SpringBoot任意版本集成Swagger各种版本
要在Spring Boot任意版本中整合Swagger,你需要做以下几步:
- 添加Swagger依赖到你的
pom.xml
或build.gradle
文件中。 - 配置Swagger。
- 添加Swagger注解。
以下是一个整合Swagger 2.x 版本的示例:
pom.xml 依赖添加:
<!-- Swagger 2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>你的Swagger版本</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>你的Swagger版本</version>
</dependency>
Swagger配置类:
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Your API Title")
.description("Your API Description")
.version("1.0.0")
.build();
}
}
使用Swagger注解:
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Api(value = "Example Controller", description = "Example API Endpoints")
public class ExampleController {
@GetMapping("/example")
@ApiOperation(value = "Example Endpoint", notes = "Returns an example response")
public String getExample() {
return "Hello, Swagger!";
}
}
确保你的Spring Boot版本与Swagger版本兼容。如果你需要整合最新的Swagger 3.x 版本,配置类中的@EnableSwagger2
注解需要替换为@EnableSwagger2WebFlux
,同时可能需要调整其他配置。
对于Swagger 3.x 的示例:
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.spi.Documentatio
评论已关闭