要在Spring Boot项目中集成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>
如果你使用的是Gradle,请在build.gradle
文件中添加以下依赖:
implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'
创建一个新的Java类,例如SwaggerConfig.java
,并添加以下代码:
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.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
}
将com.example.demo.controller
替换为你的控制器类所在的包名。
启动你的Spring Boot应用程序,然后在浏览器中访问以下URL:
http://localhost:8080/swagger-ui.html
你应该能看到Swagger UI界面,其中列出了你的API端点。你可以使用这个界面来测试你的API。
注意:以上步骤适用于Spring Boot 2.x和Swagger 2.x。如果你使用的是Spring Boot 3.x,你需要使用springdoc-openapi库来替代springfox-swagger。