温馨提示×

Ubuntu Swagger如何与Spring Boot集成

小樊
55
2025-05-01 12:52:32
栏目: 智能运维

要在Spring Boot项目中集成Swagger,你需要遵循以下步骤:

  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> 

请注意,你可能需要根据你的Spring Boot版本选择合适的Swagger版本。

  1. 配置Swagger

创建一个新的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(); } } 

在这个例子中,我们配置了一个Docket bean,它将扫描com.example.demo.controller包下的所有控制器类。你可以根据需要修改这个包名。

  1. 访问Swagger UI

启动你的Spring Boot应用程序,然后在浏览器中访问以下URL:

http://localhost:8080/swagger-ui.html 

你应该能看到Swagger UI界面,其中列出了你的API端点。你可以使用这个界面来测试你的API。

这就是在Spring Boot项目中集成Swagger的方法。现在你可以为你的REST API编写文档,并通过Swagger UI进行测试。

0