Linux系统中Swagger与Spring Boot如何结合

在Linux系统中，将Swagger与Spring Boot结合使用可以让你更方便地构建和测试RESTful API。以下是详细的步骤指南：

1. 创建Spring Boot项目

首先，你需要创建一个Spring Boot项目。你可以使用Spring Initializr（https://start.spring.io/）来快速生成项目结构。

• 选择项目类型：Maven Project 或 Gradle Project
• 选择语言：Java
• 选择Spring Boot版本
• 添加依赖：Spring Web, Springfox Swagger2

2. 配置Swagger

在你的Spring Boot项目中，添加Swagger依赖并配置Swagger。

Maven依赖

如果你使用的是Maven，在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>

Gradle依赖

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

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

3. 配置Swagger配置类

创建一个配置类来配置Swagger。

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

4. 启动Spring Boot应用

在你的主应用类上添加@SpringBootApplication注解，并启动应用。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

5. 访问Swagger UI

启动你的Spring Boot应用后，打开浏览器并访问以下URL：

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

你应该能够看到Swagger UI界面，其中列出了你的API文档。

6. 编写控制器

编写一些控制器来测试Swagger。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
}

7. 更新Swagger文档

每次你更新控制器或添加新的API时，Swagger会自动更新文档。你可以刷新浏览器页面来查看最新的API文档。

通过以上步骤，你就可以在Linux系统中成功地将Swagger与Spring Boot结合使用了。这样可以帮助你更方便地构建和测试RESTful API。

辰迅云「云服务器」，即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘，价格低至29元/月。点击查看>>