在Ubuntu上進行Swagger測試,可按以下步驟操作,主要通過安裝Swagger工具、配置API文檔并執行測試:
sudo apt update
sudo apt install -y nodejs npm
sudo npm install -g swagger-ui-express
sudo npm install -g swagger-editor
sudo apt install docker.io
docker pull swaggerapi/swagger-ui
docker run -p 8080:8080 -v /path/to/swagger.yaml:/app/swagger.yaml swaggerapi/swagger-ui
訪問 http://localhost:8080
即可查看。創建swagger.yaml
或swagger.json
示例(swagger.yaml
):
swagger: '2.0'
info:
title: Sample API
version: 1.0.0
paths:
/users:
get:
summary: List all users
responses:
200:
description: User list
集成到Express應用(可選)
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const app = express();
const swaggerDocument = YAML.load('./swagger.yaml');
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.listen(3000, () => console.log('Server running on port 3000'));
啟動后訪問 http://localhost:3000/api-docs
。
通過Swagger UI測試
http://localhost:3000/api-docs
,找到目標接口,點擊“Try it out!”。自動化測試(結合工具)
requests
庫發送HTTP請求,結合pytest
斷言結果。swagger.yaml
/swagger.json
語法正確,可通過swagger-cli
驗證。以上步驟參考自,可根據實際需求選擇工具和方法。