SpringBoot——整合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();
}
}
- 在你的Spring Boot应用程序中启用Swagger。
确保你的Spring Boot应用程序的主类上有@EnableSwagger2
注解。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
public class YourApplication {
public static void main(String[] args) {
SpringApplication.run(YourApplication.class, args);
}
}
- 运行你的Spring Boot应用程序,然后访问
http://<host>:<port>/swagger-ui.html
来查看Swagger文档。
以上步骤完成了Spring Boot项目中Swagger的整合,你可以通过定义在Controller中的API,使用Swagger注解来描述API的使用和功能。
评论已关闭