Ubuntu上Swagger文檔如何生成

在Ubuntu上生成Swagger文檔，通常需要以下幾個步驟：

1. 安裝Swagger工具

首先，你需要安裝Swagger UI和Swagger Editor?？梢允褂胣pm（Node.js的包管理器）來安裝：

# 安裝Node.js和npm（如果尚未安裝）
curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

# 安裝Swagger UI和Swagger Editor
npm install -g swagger-ui-express swagger-editor-cli

2. 創建OpenAPI規范文件

使用Swagger Editor編寫你的API規范。你可以直接在Swagger Editor的在線編輯器中編寫YAML或JSON格式的OpenAPI規范，或者將其保存為.yaml或.json文件。

# 啟動Swagger Editor CLI
swagger-editor-cli start

這將在你的默認瀏覽器中打開Swagger Editor。

3. 集成Swagger到你的應用

如果你有一個現有的Node.js應用，可以使用swagger-ui-express中間件來集成Swagger UI。

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const app = express();

// 讀取OpenAPI規范文件
const swaggerDocument = YAML.load('./path/to/your/swagger.yaml');

// 設置Swagger UI
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

將./path/to/your/swagger.yaml替換為你的OpenAPI規范文件的實際路徑。

4. 訪問Swagger UI

啟動你的Node.js應用后，你可以在瀏覽器中訪問http://localhost:3000/api-docs來查看和測試你的API文檔。

5. 自動化API文檔生成

你可以使用Swagger Codegen或OpenAPI Generator等工具來自動化API文檔的生成過程。

使用Swagger Codegen CLI

# 生成API文檔
java -jar swagger-codegen-cli.jar generate \
  -i path/to/swagger.yaml \
  -l html2 \
  -o path/to/output/directory

將path/to/swagger.yaml替換為你的OpenAPI規范文件的實際路徑，將path/to/output/directory替換為你希望生成文檔的目錄。

以上步驟適用于基于Spring Boot的Java項目，如果你使用的是其他編程語言或框架，步驟可能會有所不同。大多數現代編程語言都有相應的Swagger/OpenAPI工具和庫來幫助你實現API文檔化。