Spring Boot整合swagger
要在Spring Boot项目中整合Swagger,你需要按照以下步骤操作:
- 添加Swagger依赖到你的
pom.xml
文件中。
<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>
- 创建一个Swagger配置类。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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();
}
}
- 在
application.properties
或application.yml
中配置Swagger。
# application.properties
springfox.documentation.swagger.v2.path=/api-docs
或者
# application.yml
springfox:
documentation:
swagger:
v2:
path: /api-docs
- 启动Spring Boot应用,并访问
http://<host>:<port>/<context-path>/api-docs
来查看Swagger文档。
确保你的Spring Boot版本和Swagger版本之间是兼容的。上面的例子使用的是Swagger 2.9.2版本,适用于Spring Boot 2.x。如果你使用的是Spring Boot 1.x,可能需要使用不同的Swagger版本。
评论已关闭