在Debian上利用Swagger进行API测试可参考以下步骤:
-
安装工具
- 使用Docker安装Swagger UI:
sudo apt install docker.io docker pull swaggerapi/swagger-ui docker run -p 8080:8080 swaggerapi/swagger-ui访问
http://localhost:8080查看文档。 - 或通过npm安装(需Node.js环境):
sudo apt install nodejs npm sudo npm install -g swagger-ui-express配合Express应用生成文档。
- 使用Docker安装Swagger UI:
-
准备API规范文件
创建swagger.yaml或swagger.json文件,定义接口路径、参数、响应等,例如:swagger: '2.0' paths: /users: get: summary: "获取用户列表" responses: '200': description: "用户列表" -
启动Swagger UI测试
- 若使用Docker,直接访问
http://localhost:8080即可查看接口并测试。 - 若通过Express集成,启动应用后访问
http://localhost:3000/api-docs。
- 若使用Docker,直接访问
-
自动化测试(可选)
- 使用Swagger Codegen生成客户端代码,编写单元测试脚本(如Python的
unittest):pip3 install swagger-codegen swagger-codegen generate -i swagger.yaml -l python -o ./generated通过生成的代码调用API并断言响应。
- 结合CI/CD工具(如Jenkins)集成测试脚本,实现自动化验证。
- 使用Swagger Codegen生成客户端代码,编写单元测试脚本(如Python的
说明:优先通过Swagger UI手动测试接口逻辑,再通过代码生成工具实现自动化,确保测试覆盖率和效率。