如何在CentOS上配置Swagger UI - 问答

在CentOS上配置Swagger UI，可以按照以下步骤进行：

1. 安装必要的软件包

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

sudo yum install java-1.8.0-openjdk-devel maven

2. 创建一个新的Maven项目

你可以使用以下命令创建一个新的Maven项目：

mvn archetype:generate -DgroupId=com.example -DartifactId=swagger-ui-demo -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false

3. 配置Swagger

进入项目目录并编辑pom.xml文件，添加Swagger依赖：

<dependencies>
    <!-- Swagger dependencies -->
    <dependency>
        <groupId>io.swagger.core.v3</groupId>
        <artifactId>swagger-annotations</artifactId>
        <version>2.1.12</version>
    </dependency>
    <dependency>
        <groupId>io.swagger.core.v3</groupId>
        <artifactId>swagger-models</artifactId>
        <version>2.1.12</version>
    </dependency>
    <dependency>
        <groupId>io.swagger.core.v3</groupId>
        <artifactId>swagger-ui</artifactId>
        <version>3.54.0</version>
    </dependency>
</dependencies>

4. 创建Swagger配置类

在src/main/java/com/example目录下创建一个新的Java类，例如SwaggerConfig.java，并添加以下代码：

package com.example;

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"))
                .paths(PathSelectors.any())
                .build();
    }
}

5. 创建一个简单的REST控制器

在src/main/java/com/example目录下创建一个新的Java类，例如HelloController.java，并添加以下代码：

package com.example;

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, World!";
    }
}

6. 配置Spring Boot应用程序

在src/main/java/com/example目录下创建一个新的Java类，例如SwaggerUiDemoApplication.java，并添加以下代码：

package com.example;

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

@SpringBootApplication
public class SwaggerUiDemoApplication {

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

7. 构建并运行项目

使用以下命令构建并运行项目：

mvn clean install
java -jar target/swagger-ui-demo-1.0-SNAPSHOT.war

8. 访问Swagger UI

打开浏览器并访问http://localhost:8080/swagger-ui.html，你应该能够看到Swagger UI界面，并且可以查看和测试你的API。

注意事项

确保你的Spring Boot版本与Swagger依赖版本兼容。
如果你使用的是Spring Boot 2.6及以上版本，可能需要调整Swagger配置以适应新的Spring Boot版本。

通过以上步骤，你应该能够在CentOS上成功配置Swagger UI。

0 赞

0 踩