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

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

安裝Node.js和npm

首先，需要在Linux服務器上安裝Node.js和npm?？梢酝ㄟ^以下命令進行安裝：

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs
node -v
npm -v

安裝Swagger Editor和Swagger UI

下載并解壓Swagger Editor和Swagger UI：

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

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

啟動Swagger Editor和Swagger UI：

npm install -g http-server
http-server -p 8080 # 啟動Swagger Editor
http-server -p 8081 # 啟動Swagger UI

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

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

如果你使用的是Spring Boot項目，可以集成Swagger來自動生成API文檔。添加相關依賴并配置Swagger：

在 pom.xml 中添加依賴：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.1.0</version>
</dependency>

配置 application.properties 文件：

springdoc.api-docs.path=/api-docs
springdoc.swagger-ui.path=/swagger-ui

啟動Spring Boot應用后，訪問 http://your_server_ip:8080/swagger-ui 即可查看生成的API文檔。

遠程訪問Swagger Editor（可選）

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

部署Swagger Editor Docker：

docker pull swaggerapi/swagger-editor
docker run -p 8088:8080 -d swaggerapi/swagger-editor

使用Cpolar實現遠程訪問：

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

使用Swagger API文檔共享

• Swagger API 文檔生成：開發者通過定義 API 的 OpenAPI 規范文件(通常為 JSON 或 YAML 格式), Swagger 工具就能根據這些規范自動生成交互式的 API 文檔。
• Swagger UI：Swagger UI 是 Swagger 工具集中的一個組件, 它負責將 OpenAPI 規范文件呈現為人性化的 Web 頁面。用戶可以通過 Swagger UI 查看和測試 API 的所有接口, 這使得 API 的使用和測試更加直觀和方便。
• GitHub Pages：GitHub Pages 是一個免費的靜態站點托管服務, 允許用戶直接從 GitHub 倉庫發布網站內容。開發者可以利用 GitHub Pages 展示個人或項目的介紹頁面、博客或者文檔。

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