如何在Linux中使用Swagger進行API文檔共享

在Linux中使用Swagger進行API文檔共享，可以按照以下步驟進行：

1. 安裝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

2. 安裝Swagger Editor

下載并解壓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

3. 啟動Swagger Editor

使用http-server啟動Swagger Editor：

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

# 啟動Swagger Editor
http-server -p 8080

現在，可以通過瀏覽器訪問http://your_server_ip:8080來使用Swagger Editor。

4. 安裝Swagger UI

下載并解壓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

5. 啟動Swagger UI

使用http-server啟動Swagger UI：

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

# 啟動Swagger UI
http-server -p 8081

現在，可以通過瀏覽器訪問http://your_server_ip:8081來使用Swagger UI。

6. 集成Swagger到Spring Boot項目（可選）

如果你使用的是Spring Boot項目，可以集成Swagger來自動生成API文檔：

添加依賴

在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

創建一個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();
    }
}

啟動應用程序

啟動你的Spring Boot應用程序，并訪問http://localhost:8080/swagger-ui.html來查看Swagger UI。

7. 遠程訪問Swagger Editor（可選）

可以使用Docker和Cpolar來實現Swagger Editor的遠程訪問：

部署Swagger Editor Docker

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

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

使用Cpolar實現遠程訪問

1. 安裝Cpolar并配置內網穿透。
2. 在Swagger Editor容器中配置公網地址。
3. 使用Cpolar生成的公網地址進行遠程訪問。

通過以上步驟，你可以在Linux系統中成功部署和使用Swagger進行API文檔共享。