在Ubuntu上安裝Swagger,你可以選擇安裝Swagger UI或者Swagger Editor。以下是兩種方法的詳細步驟:
更新系統包列表
sudo apt update
安裝Swagger UI 你可以通過npm(Node.js的包管理器)來安裝Swagger UI。首先,確保你已經安裝了Node.js和npm。
sudo apt install nodejs npm
然后,使用npm全局安裝Swagger UI:
sudo npm install -g swagger-ui-express
啟動Swagger UI 創建一個簡單的Express服務器來托管Swagger UI。
mkdir swagger-ui-example
cd swagger-ui-example
npm init -y
npm install express
創建一個名為server.js
的文件,并添加以下內容:
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
// Load Swagger document
const swaggerDocument = YAML.load('./swagger.yaml');
const app = express();
// Serve Swagger docs
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}`);
});
創建一個名為swagger.yaml
的文件,并添加你的Swagger文檔。
啟動服務器:
node server.js
現在,你可以在瀏覽器中訪問http://localhost:3000/api-docs
來查看Swagger UI。
更新系統包列表
sudo apt update
安裝Swagger Editor 你可以通過npm來安裝Swagger Editor。
sudo npm install -g swagger-editor
啟動Swagger Editor 啟動Swagger Editor:
swagger-editor
這將在默認瀏覽器中打開Swagger Editor。
sudo
來提升權限。通過以上步驟,你應該能夠在Ubuntu上成功安裝并運行Swagger UI或Swagger Editor。