在Linux中調試Swagger API,你可以遵循以下步驟:
npm install -g swagger-ui-express
app.js
的文件,并添加以下代碼以創建一個簡單的Express應用:const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const app = express();
const port = process.env.PORT || 3000;
// 讀取Swagger JSON文件
const swaggerDocument = YAML.load('./swagger.json');
// 使用swagger-ui-express中間件
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.listen(port, () => {
console.log(`Server is running at http://localhost:${port}`);
});
創建Swagger JSON文件:在你的項目文件夾中,創建一個名為swagger.json
的文件。這個文件將包含你的API的Swagger定義。你可以手動編寫這個文件,或者使用Swagger Editor(https://editor.swagger.io/)來創建和編輯它。確保你的Swagger定義包含了所有必要的信息,例如API端點、參數、請求和響應類型等。
運行你的應用:在終端中,導航到你的項目文件夾,然后運行以下命令來啟動你的應用:
node app.js
訪問Swagger UI:在瀏覽器中,訪問http://localhost:3000/api-docs
。你應該能看到你的API的交互式文檔,你可以在其中測試各種端點、發送請求并查看響應。
調試:如果你的API沒有按預期工作,你可以使用以下方法進行調試:
app.js
中添加console.log
語句以查看變量和函數的值。通過遵循這些步驟,你應該能夠在Linux中調試Swagger API。