centos

CentOS Swagger如何集成API

小樊
40
2025-09-22 08:57:40
栏目: 智能运维

在CentOS上集成Swagger以管理和展示API文档,可以按照以下步骤进行:

1. 安装必要的软件

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

sudo yum install java-1.8.0-openjdk-devel maven

2. 创建Maven项目

使用Maven创建一个新的Java项目:

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

3. 添加Swagger依赖

编辑pom.xml文件,添加Swagger和Spring Boot相关依赖:

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Swagger2 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Swagger UI -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
</dependencies>

4. 配置Swagger

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

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

5. 创建API控制器

创建一个简单的REST控制器来测试Swagger:

package com.example.demo;

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

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

mvn spring-boot:run

7. 访问Swagger UI

打开浏览器并访问以下URL以查看Swagger UI界面:

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

你应该能够看到你的API文档,并且可以测试这些API。

总结

通过以上步骤,你可以在CentOS上成功集成Swagger来管理和展示API文档。Swagger提供了一个直观的界面,使得API的开发和测试变得更加方便。

0
看了该问题的人还看了