Linux Swagger如何与Spring Boot结合使用

在Linux系统上将Swagger与Spring Boot结合使用，可以帮助你创建、测试和文档化你的RESTful API。以下是集成Swagger与Spring Boot的步骤：

1. 添加依赖

在你的Spring Boot项目的pom.xml文件中添加Swagger和Springfox的依赖。例如，使用Maven时，添加以下依赖：

<dependencies>
    <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>
</dependencies>

如果你使用的是Gradle，则在build.gradle文件中添加以下依赖：

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}

2. 配置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替换为你实际的控制器包名。

3. 启动Spring Boot应用

使用以下命令启动你的Spring Boot应用：

• 如果你使用Maven：

  ./mvnw spring-boot:run
  

• 如果你使用Gradle：

  ./gradlew bootRun
  

4. 访问Swagger UI

一旦你的应用启动，你可以通过浏览器访问Swagger UI。默认情况下，Swagger UI的地址是：

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

在这里，你可以查看和测试你的API。

5. 配置Swagger UI（可选）

你可以进一步自定义Swagger UI，例如添加认证、自定义样式等。以下是一个简单的示例，展示如何添加基本认证：

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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.Collections;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置文档标题
                .title("Your API Title")
                // 设置联系人信息
                .contact(new Contact("Your Name", "www.example.com", "your.email@example.com"))
                // 设置更多信息...
                .version("Version Number")
                .build();
    }
}

通过以上步骤，你应该能够在Linux环境中成功集成Swagger与Spring Boot，并使用Swagger UI来测试和文档化你的API。