温馨提示×

Linux中Swagger接口测试步骤是什么

小樊
68
2025-04-09 03:02:12
栏目: 智能运维

在Linux系统下使用Swagger进行接口测试的步骤如下:

安装Swagger

  1. 安装Swagger Editor
  • 拉取Docker镜像:
docker pull swaggerapi/swagger-editor:v4.6.0
  • 运行容器:
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
  1. 安装Swagger UI
  • 拉取Docker镜像:
docker pull swaggerapi/swagger-ui:v4.15.5
  • 运行容器:
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
  1. 安装Swagger命令行工具(可选):
  • 使用npm全局安装:
npm install -g swagger

配置Swagger

  1. 导入Swagger配置文件
  • 打开Swagger Editor,点击左上角的【File】-【Import File】,导入你的swagger.jsonswagger.yaml文件。
  1. 配置Spring Boot项目(如果使用Spring Boot)
  • 添加Swagger依赖到pom.xml
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>
  • 编写Swagger配置类并启用Swagger2。

启动Swagger

  1. 启动Swagger Editor
  • 在浏览器中访问http://localhost:38080,登录后导入配置文件即可使用。
  1. 启动Swagger UI
  • 在浏览器中访问http://localhost:38081/swagger-ui.html,查看并测试API接口。

测试接口

  1. 查看接口文档
  • 在Swagger UI界面中,浏览不同路径下的接口,查看它们的详细描述、请求参数、响应格式等。
  1. 测试API接口
  • 点击“TRY IT OUT”按钮,输入必要的参数,发送请求并查看返回结果。

注意事项

  • 确保Swagger UI容器正在运行,并且端口映射正确。
  • 如果需要对Swagger UI进行安全配置,如添加密码保护,可以参考相关文档。

通过以上步骤,你可以在Linux系统下成功部署Swagger并测试你的API接口。

0