在 Ubuntu 上運行 Swagger,通常是指使用 Swagger UI 來可視化你的 API 文檔。Swagger UI 是一個可以和任何實現了 Swagger(現在稱為 OpenAPI)規范的 RESTful API 交互的工具。以下是在 Ubuntu 上運行 Swagger UI 的步驟:
安裝 Node.js 和 npm: Swagger UI 可以通過 Node.js 來運行。首先,你需要安裝 Node.js 和 npm(Node.js 的包管理器)。你可以使用以下命令來安裝它們:
sudo apt update
sudo apt install nodejs npm
安裝完成后,你可以通過運行以下命令來檢查它們的版本,確保它們已經正確安裝:
node -v
npm -v
安裝 Swagger UI Express: Swagger UI Express 是一個可以在 Express 應用程序中使用的 Swagger UI 中間件。你可以通過 npm 來安裝它:
npm install swagger-ui-express
創建一個簡單的 Express 應用程序:
創建一個新的 JavaScript 文件,比如 app.js
,并添加以下代碼來創建一個基本的 Express 應用程序,它將使用 Swagger UI Express 來提供 Swagger UI:
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
// 讀取 Swagger 文檔
const swaggerDocument = YAML.load('./swagger.yaml');
const app = express();
// 使用 Swagger UI Express 中間件
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
// 啟動服務器
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running at http://localhost:${port}/api-docs`);
});
在這個例子中,我們假設你有一個名為 swagger.yaml
的 Swagger 文檔文件。
下載 Swagger 文檔:
如果你還沒有 Swagger 文檔,你可以使用 Swagger Editor 來創建一個,或者從現有的 API 生成一個。將生成的 swagger.yaml
文件放在你的項目目錄中。
運行你的應用程序: 在終端中,導航到你的項目目錄,并運行以下命令來啟動你的應用程序:
node app.js
訪問 Swagger UI:
打開你的網絡瀏覽器,訪問 http://localhost:3000/api-docs
,你應該能夠看到 Swagger UI 界面,它將允許你與你的 API 交互。
請注意,這些步驟假設你已經有了一個 Swagger/OpenAPI 規范的文檔。如果你需要從頭開始創建一個 Swagger 文檔,你可以使用 Swagger Editor(https://editor.swagger.io/)來幫助你。