本文介紹如何在spring Boot項目中集成Swagger，方便API文檔的生成和測試。 以下步驟將指導您完成集成過程：
1. 添加依賴項:
在您的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>
請根據您的項目需求選擇合適的版本號。
2. Swagger配置:
創建一個名為SwaggerConfig.Java的類，并添加以下代碼：
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.basePackage("your.base.package")) //替換為您的控制器包名 .paths(PathSelectors.any()) .build(); } }
記住將”your.base.package”替換成您spring boot項目中控制器類的包名。
3. 訪問Swagger UI:
啟動Spring Boot應用后，在瀏覽器中訪問以下URL：
http://localhost:8080/swagger-ui.html
您應該能夠看到Swagger UI界面，其中列出了所有可用的API。
4. 高級配置 (可選):
您可以進一步自定義Swagger配置，例如添加API信息、全局參數等。以下是一個更詳細的配置示例：
import springfox.documentation.builders.*; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Parameter; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; import java.util.List; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { List<Parameter> params = new ArrayList<>(); params.add(new ParameterBuilder() .name("Authorization") .description("Access token") .modelRef(new ModelRef("string")) .parameterType("header") .required(false) .build()); ApiInfo apiInfo = new ApiInfoBuilder() .title("My API") .description("My API description") .version("1.0.0") .contact("Your Name") .build(); return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo) .select() .apis(RequestHandlerSelectors.basePackage("your.base.package")) //替換為您的控制器包名 .paths(PathSelectors.any()) .build() .globalOperationParameters(params); } }
完成以上步驟后，您就成功將Swagger集成到Spring Boot項目中了，可以使用Swagger UI方便地瀏覽和測試您的API。
? 版權聲明
文章版權歸作者所有，未經允許請勿轉載。
THE END
