温馨提示×

CentOS下Swagger与Spring Boot如何联调

小樊
39
2025-12-07 19:35:15
栏目: 智能运维

在CentOS环境下,将Swagger与Spring Boot进行联调需要遵循以下步骤:

1. 环境准备

确保你的CentOS系统已经安装了Java和Maven。如果没有安装,可以使用以下命令进行安装:

sudo yum install java-1.8.0-openjdk-devel
sudo yum install maven

2. 创建Spring Boot项目

你可以使用Spring Initializr来创建一个新的Spring Boot项目。访问https://start.spring.io/,选择所需的依赖项(如Spring Web),然后生成项目并下载到本地。

3. 添加Swagger依赖

在你的Spring Boot项目的pom.xml文件中添加Swagger依赖:

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

4. 配置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();
    }
}

5. 创建控制器

创建一个简单的控制器来测试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 HelloController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Swagger!";
    }
}

6. 启动Spring Boot应用

在项目根目录下运行以下命令来启动Spring Boot应用:

mvn spring-boot:run

7. 访问Swagger UI

打开浏览器,访问http://<your-server-ip>:<port>/swagger-ui.html,其中<your-server-ip>是你的CentOS服务器的IP地址,<port>是Spring Boot应用的端口号(默认是8080)。

8. 调试

如果Swagger UI没有正确显示,可以检查以下几点:

  • 确保Spring Boot应用已经成功启动。
  • 确保Swagger配置类和控制器类在正确的包路径下。
  • 检查浏览器控制台是否有任何错误信息。

通过以上步骤,你应该能够在CentOS环境下成功地将Swagger与Spring Boot进行联调。

0