Linux环境下Swagger与SpringBoot集成详细教程

本文提供在Linux系统下，使用Swagger与Spring Boot集成生成RESTful API文档的完整教程。 教程详细介绍了添加Maven依赖`springfox-swagger2`和`springfox-swagger-ui`，配置SwaggerConfig类，以及最终访问`http://localhost:8080/swagger-ui.html`查看API文档的步骤。 文中特别提示了Linux环境下可能遇到的防火墙端口开放问题及Spring Boot应用启动确认。 通过此教程，开发者可以快速便捷地生成和测试Spring Boot项目的API文档。

在Linux系统中，借助Swagger集成Spring Boot项目，可以高效便捷地生成RESTful API文档。以下步骤将指导您完成集成过程：

第一步：添加依赖

在您的Spring Boot项目的pom.xml文件中，添加以下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>

第二步：Swagger配置

创建一个名为SwaggerConfig.java的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("com.example.demo.controller")) // 请替换为您的控制器包名
                .paths(PathSelectors.any())
                .build();
    }
}

请务必将com.example.demo.controller替换为您实际的控制器包名。

第三步：访问Swagger UI

启动Spring Boot应用后，在浏览器中访问以下URL：

<code>http://localhost:8080/swagger-ui.html</code>

您将看到Swagger UI界面，其中包含了所有已注册的API接口信息。您可以直接在此界面测试您的API。

重要提示： 如果在Linux环境下无法访问http://localhost:8080/swagger-ui.html，请检查您的防火墙设置，确保8080端口已开放。 此外，请确认Spring Boot应用已成功启动并在监听8080端口。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Linux环境下Swagger与SpringBoot集成详细教程》文章吧，也可关注golang学习网公众号了解相关技术文章。