centos

如何部署CentOS上的Swagger

小樊
45
2025-09-22 09:00:44
栏目: 智能运维

在CentOS上部署Swagger主要涉及以下几个步骤:

1. 安装必要的软件包

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

sudo yum install java-1.8.0-openjdk-devel maven

2. 下载并配置Swagger

你可以从Swagger的官方网站下载Swagger的源码或者使用Maven来构建Swagger。

使用Maven构建Swagger

如果你选择使用Maven,可以在你的项目目录下创建一个pom.xml文件,并添加Swagger的依赖:

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>swagger-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>swagger-demo</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <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-parser</artifactId>
            <version>2.0.28</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

然后,在项目目录下运行以下命令来构建项目:

mvn clean install

3. 配置Swagger

在你的Spring Boot应用中,配置Swagger以生成API文档。首先,添加Swagger依赖到你的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>

然后,创建一个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"))
                .paths(PathSelectors.any())
                .build();
    }
}

4. 启动应用

启动你的Spring Boot应用,Swagger UI将会自动可用。默认情况下,你可以通过访问http://<your-server-ip>:<port>/swagger-ui.html来查看API文档。

5. 部署到生产环境

如果你打算将应用部署到生产环境,可以考虑以下几点:

通过以上步骤,你应该能够在CentOS上成功部署Swagger并生成API文档。

0
看了该问题的人还看了