Spring Boot-集成Swagger
要在Spring Boot项目中集成Swagger,你需要按照以下步骤操作:
- 添加Swagger依赖到你的
pom.xml
文件中。 - 创建Swagger配置类。
- 在Spring Boot应用的主类或者配置类中启用Swagger。
以下是一个简单的示例:
Step 1: 添加Swagger依赖
<!-- Swagger -->
<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>
Step 2: 创建Swagger配置类
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
Step 3: 启用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);
}
}
完成以上步骤后,你可以通过访问http://<your-host>:<server-port>/swagger-ui.html
来查看Swagger文档页面。
请注意,版本号(2.9.2
在这个例子中)可能会更新,请使用最新的稳定版本。
评论已关闭