Linux系统中Swagger与Spring Boot如何集成

在Linux系统中，将Swagger与Spring Boot集成可以帮助你创建和维护一个结构良好的API文档。以下是集成Swagger与Spring Boot的步骤：

1. 添加依赖

首先，在你的Spring Boot项目的pom.xml文件中添加Swagger和Springfox的依赖：

<dependencies>
    
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>

    
    <dependency>
        <groupId>io.springfoxgroupId>
        <artifactId>springfox-swagger2artifactId>
        <version>2.9.2version>
    dependency>

    
    <dependency>
        <groupId>io.springfoxgroupId>
        <artifactId>springfox-swagger-uiartifactId>
        <version>2.9.2version>
    dependency>
dependencies>

2. 配置Swagger

创建一个配置类来配置Swagger。这个类需要使用@Configuration注解，并且包含一个方法来配置Swagger的Docket bean。

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();
    }
}

3. 启动Spring Boot应用

确保你的Spring Boot应用已经启动。你可以使用以下命令来启动应用：

./mvnw spring-boot:run

4. 访问Swagger UI

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

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

5. 配置Swagger UI（可选）

你可以进一步配置Swagger UI，例如添加自定义的标题、描述等。以下是一个示例配置：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) // 替换为你的控制器包路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API Documentation")
                .description("API Documentation for Spring Boot Application")
                .version("1.0.0")
                .build();
    }
}

6. 验证集成

确保你的控制器类和方法上有适当的Swagger注解，例如@Api、@ApiOperation等，以便Swagger能够正确生成文档。

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
@Api(tags = "Example Controller")
public class ExampleController {

    @GetMapping("/hello")
    @ApiOperation("Get a greeting message")
    public String sayHello() {
        return "Hello, World!";
    }
}

通过以上步骤，你应该能够在Linux系统中成功集成Swagger与Spring Boot，并且能够通过Swagger UI查看和测试你的API文档。

以上就是关于“Linux系统中Swagger与Spring Boot如何集成”的相关介绍，筋斗云是国内较早的云主机应用的服务商，拥有10余年行业经验，提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩，主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复；电子化备案，提交快速，专业团队7×24小时服务支持！

简单好用、高性价比云服务器租用链接：https://www.jindouyun.cn/product/cvm