Swagger在Linux系统中的部署流程是怎样的 - 问答

在Linux系统中部署Swagger的流程大致如下：

1. 安装Java环境

Swagger是一个基于Java的API文档生成工具，因此你需要一个Java开发环境。你可以使用OpenJDK或Oracle JDK来安装Java。

sudo apt update
sudo apt install openjdk-11-jdk

2. 设置Maven或Gradle

如果你使用Maven或Gradle来构建你的项目，确保你已经正确配置了依赖项。

Maven

在你的 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>

Gradle

在你的 build.gradle 文件中添加Swagger依赖项：

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}

3. 配置Swagger

创建一个Swagger配置类来启用Swagger文档生成。

Spring Boot

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

Spring MVC

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

4. 启动应用程序

启动你的Spring Boot或Spring MVC应用程序。Swagger应该会自动生成API文档，并且你可以在浏览器中访问 http://localhost:8080/swagger-ui.html（假设你的应用程序运行在端口8080上）来查看和测试API文档。

5. 访问Swagger UI

打开浏览器并访问 http://localhost:8080/swagger-ui.html，你应该能够看到Swagger UI界面，其中列出了你的所有API端点。你可以点击每个端点来查看请求和响应的详细信息。

6. 解决端口访问问题（如果有）

如果在Linux上部署时遇到端口访问问题，可以通过修改程序启动命令解决外部访问限制。例如，使用 java -jar 命令启动时，可以添加参数来允许外部访问：

java -jar -Dserver.address=0.0.0.0 your-application.jar

7. 使用Swagger Editor（可选）

如果你需要在线编辑和测试API文档，可以使用Swagger Editor。你可以自己搭建一个Swagger Editor实例，或者使用官方提供的在线版本。

搭建Swagger Editor

下载并解压Swagger Editor：

cd /home/user
wget https://github.com/swagger-api/swagger-editor/archive/v3.7.0.tar.gz
tar -zxvf swagger-editor-3.7.0.tar.gz
mv swagger-editor-3.7.0 swagger-editor

安装HttpServer并配置环境变量：

sudo npm install -g http-server
export PATH=$PATH:/home/user/swagger-editor/node_modules/http-server/bin

运行Swagger Editor：

cd swagger-editor
http-server -p 8080

在浏览器中访问 http://your-server-ip:8080 即可使用Swagger Editor。

以上就是在Linux系统中部署Swagger的基本流程。根据你的具体项目和技术栈，可能需要进行一些调整。

0 赞

0 踩