centos

centos swagger与springboot集成

小樊
36
2025-08-10 18:21:34
栏目: 智能运维

在CentOS系统上集成Swagger与Spring Boot,可以按照以下步骤进行:

1. 创建Spring Boot项目

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

2. 添加Swagger依赖

如果你选择使用Swagger 2.x,可以在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>

如果你选择使用OpenAPI 3.x,可以在pom.xml中添加以下依赖:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.2</version>
</dependency>

3. 配置Swagger

对于Swagger 2.x:

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

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

对于OpenAPI 3.x:

Springdoc OpenAPI会自动配置Swagger UI,你只需要在application.propertiesapplication.yml中进行一些基本配置:

springdoc.api-docs.path=/v3/api-docs
springdoc.swagger-ui.path=/swagger-ui.html

4. 启动Spring Boot应用

启动你的Spring Boot应用,然后访问以下URL来查看Swagger UI:

5. 编写API文档

在你的控制器类和方法上添加Swagger注解,以便生成详细的API文档。例如:

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@RestController
@RequestMapping("/api")
@Api(tags = "示例控制器")
public class ExampleController {

    @GetMapping("/hello")
    @ApiOperation("返回一个简单的问候语")
    public String sayHello() {
        return "Hello, World!";
    }
}

6. 部署到CentOS

将你的Spring Boot应用打包成JAR文件,并上传到CentOS服务器。你可以使用以下命令来打包和运行应用:

# 打包应用
mvn clean package

# 上传JAR文件到CentOS服务器
scp target/your-application.jar user@centos-server:/path/to/deploy

# 在CentOS服务器上运行应用
ssh user@centos-server
cd /path/to/deploy
java -jar your-application.jar

现在,你的Spring Boot应用应该在CentOS服务器上运行,并且可以通过浏览器访问Swagger UI来查看和测试API文档。

0
看了该问题的人还看了