在Linux环境下使用Swagger进行接口测试,可以按照以下步骤进行:
安装Swagger
- 安装Swagger Editor:
- 拉取Docker镜像:
docker pull swaggerapi/swagger-editor:v4.6.0
- 运行容器:
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
- 打开浏览器,访问
http://localhost:38080
使用Swagger Editor。
- 安装Swagger UI:
- 拉取Docker镜像:
docker pull swaggerapi/swagger-ui:v4.15.5
- 运行容器:
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
- 打开浏览器,访问
http://localhost:38081
使用Swagger UI。
- 通过npm安装Swagger命令行工具(适用于Node.js环境):
npm install -g swagger
配置和使用Swagger
- 配置Swagger:
- 进入项目目录,编辑
swagger.yaml
或swagger.json
文件,配置API的基本信息、端点、参数、请求和响应等。
- 启动Swagger:
- 配置完成后,通过命令行启动Swagger,启动后会在浏览器中打开一个界面,显示API文档。
- 测试接口:
- 在Swagger UI界面中,点击“TRY IT OUT”按钮来测试API请求。
- 输入必要的参数,然后发送请求并查看返回结果。
例如,对于 /user/query-user-info
接口,点击 Try it out 后输入参数并执行请求,即可看到接口的响应结果。
使用curl命令进行接口测试
除了使用Swagger UI进行接口测试外,还可以使用curl命令在Linux终端中进行接口测试。以下是一些示例:
- 参数在URL后面:
curl http://172.16.110.147:9090/client/selectByPage?limit=10&page=1
- 参数不在URL后面,使用data形式传参:
curl -X POST http://172.16.110.147:9090/factory/insert -H "Content-Type: application/x-www-form-urlencoded" -d "factoryName=TestFactory&no=123&remark=TestRemark"
- 参数不在URL后面,使用data形式传参,参数为对象形式:
curl -X POST http://172.16.110.147:9090/material/selectAll -H "Content-Type: application/json" -d '{"factory":"TestFactory","materialName":"TestMaterial","materialNo":"12345","offset":0,"page":1,"pageSize":10}'
- 将文件以formData形式传递:
curl -X POST http://172.16.110.147:9090/api/all/order/money -F "file=@/path/to/file" -F "startTime=2020-01-01" -F "endTime=2020-06-30"
通过上述步骤,你可以在Linux系统下使用Swagger来测试你的API接口,从而提高开发和调试的效率。