Linux Swagger如何与Spring Boot集成 - 问答

要在Spring Boot中集成Swagger，你需要遵循以下步骤：

添加依赖

在你的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.9.2版本的Swagger，你可以根据需要选择其他版本。

配置Swagger

创建一个Java类，例如SwaggerConfig.java，并添加以下代码：

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
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()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot Swagger 示例")
                .description("Spring Boot + Swagger 的集成示例")
                .version("1.0")
                .build();
    }
}

在这个配置类中，我们定义了一个名为api的Docket Bean。这个Bean用于配置Swagger的基本信息，如API标题、描述和版本。我们还指定了要扫描的包（在这里是com.example.demo.controller），以便Swagger能够找到并生成API文档。

访问Swagger UI

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

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

这将打开Swagger UI界面，你可以在这里查看和测试你的API。

注意：如果你使用的是Spring Boot 2.6及以上版本，你可能需要添加以下配置以避免与Spring Boot Actuator的冲突：

import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
    // ...
}

并将@EnableSwagger2替换为@EnableSwagger2WebMvc。

0 赞

0 踩