linux

Linux系统中Swagger如何集成Spring Boot

小樊
48
2025-08-06 23:48:30
栏目: 智能运维

在Linux系统中集成Swagger到Spring Boot应用程序中,可以按照以下步骤进行:

  1. 添加依赖: 在你的Spring Boot项目的pom.xml文件中添加Swagger的依赖。如果你使用的是Maven,可以添加以下依赖:

    <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'
    
  2. 配置Swagger: 创建一个配置类来配置Swagger。例如:

    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;
    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.basePackage("com.example.demo.controller")) // 替换为你的控制器包路径
                    .paths(PathSelectors.any())
                    .build();
        }
    }
    
  3. 访问Swagger UI: 启动你的Spring Boot应用程序后,你可以通过浏览器访问Swagger UI。默认情况下,Swagger UI的地址是:

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

    请确保你的Spring Boot应用程序运行在8080端口上,或者根据实际情况修改URL中的端口号。

  4. 验证集成: 打开Swagger UI页面,你应该能够看到你的API文档,并且可以进行测试。

注意事项

通过以上步骤,你可以在Linux系统中成功集成Swagger到Spring Boot应用程序中,并通过Swagger UI进行API文档的查看和测试。

0
看了该问题的人还看了