如何使用Swagger在Linux上进行API文档共享

在Linux上使用Swagger进行API文档共享，可以按照以下步骤进行：

安装Node.js和npm

首先，需要在Linux系统上安装Node.js和npm。可以通过以下命令进行安装：

# 安装Node.js
curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

# 验证安装
node -v
npm -v

安装Swagger Editor

1. 下载并解压Swagger Editor：

# 下载Swagger Editor
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.50.0.tar.gz

# 解压
tar -xvf swagger-editor-3.50.0.tar.gz

# 进入解压后的目录
cd swagger-editor-3.50.0

2. 启动Swagger Editor：

# 全局安装http-server
npm install -g http-server

# 启动Swagger Editor
http-server -p 8080

现在，可以通过浏览器访问 http://your_server_ip:8080 来使用Swagger Editor。

安装Swagger UI

1. 下载并解压Swagger UI：

# 下载Swagger UI
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.50.0.tar.gz

# 解压
tar -xvf swagger-ui-3.50.0.tar.gz

# 进入解压后的目录
cd swagger-ui-3.50.0

2. 启动Swagger UI：

# 全局安装http-server
npm install -g http-server

# 启动Swagger UI
http-server -p 8081

现在，可以通过浏览器访问 http://your_server_ip:8081 来使用Swagger UI。

集成Swagger到Spring Boot项目（可选）

如果你使用的是Spring Boot项目，可以集成Swagger来自动生成API文档：

1. 添加依赖：

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

2. 配置Swagger：

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("My API")
                .description("My API description")
                .version("1.0")
                .build();
    }
}

3. 启动应用程序：

启动你的Spring Boot应用程序，并访问 http://localhost:8080/swagger-ui.html 来查看Swagger UI。

远程访问Swagger Editor（可选）

可以使用Docker和Cpolar来实现Swagger Editor的远程访问：

1. 部署Swagger Editor Docker：

# 拉取Swagger Editor容器
docker pull swaggerapi/swagger-editor

# 运行容器，将8080端口映射到宿主机的8088端口
docker run -p 8088:8080 -d swaggerapi/swagger-editor

2. 使用Cpolar实现远程访问：

• 安装Cpolar并配置内网穿透。
• 在Swagger Editor容器中配置公网地址。
• 使用Cpolar生成的公网地址进行远程访问。

通过以上步骤，你可以在Linux系统中成功部署和使用Swagger进行API文档共享。