温馨提示×

centos swagger测试方法

小樊
54
2025-07-27 00:19:31
栏目: 智能运维

在CentOS系统上测试Swagger主要涉及到安装和配置Swagger相关工具,以及使用这些工具进行API文档生成和测试。以下是详细的步骤:

安装Swagger

  • 使用npm安装

    1. 确保Node.js和npm已安装:
      sudo yum install -y nodejs npm
      
    2. 安装Swagger Editor和Swagger UI:
      mkdir /opt/swagger
      cd /opt/swagger
      wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.14.0.tar.gz
      tar -xzf v3.14.0.tar.gz
      cd swagger-editor-3.14.0
      npm install -g http-server
      http-server -p 8080
      
      访问 http://localhost:8080 确认可以访问。
    3. 安装Swagger UI:
      cd /opt/swagger
      wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.34.0.tar.gz
      tar -xzf v3.34.0.tar.gz
      cd swagger-ui-3.34.0
      npm install express --save
      mkdir public
      cp -r ../swagger-ui/dist/ public/
      
    4. 启动Swagger UI:
      cd /opt/swagger
      node index.js
      
      访问 http://localhost:3000 确认可以访问。
  • 使用Docker安装

    1. 安装Docker:
      sudo yum install -y docker
      sudo systemctl start docker
      sudo systemctl enable docker
      
    2. 拉取Swagger UI镜像:
      docker pull swaggerapi/swagger-ui-express
      
    3. 运行容器:
      docker run -p 80:80 -d swaggerapi/swagger-ui-express
      
      这样,Swagger UI将会在 http://<your_server_ip> 上可用。

配置Swagger UI显示自定义接口文档

  • 在Swagger Editor编写接口文档,保存为JSON文件。
  • 将JSON文件上传至 /opt/swagger/public
  • 修改 /opt/swagger/public/index.html 中的URL,指向自己的JSON文件。
  • 刷新界面即可查看自定义的接口文档。

使用Swagger Editor快速生成API文档

  • 下载Swagger定义文件(swagger.yaml 或 swagger.json)。
  • 在Swagger Editor中导入该文件,即可快速生成API文档。

调试技巧

  • 自动化授权:编辑 custom.js 文件,自动获取并设置token。
  • 结合Burp Suite进行安全测试:使用Burp Suite作为上游代理,捕获Swagger UI的请求并测试接口安全性。

以上步骤应该可以帮助你在CentOS系统上成功部署和测试Swagger。如果在执行过程中遇到问题,请检查网络连接和防火墙设置,确保相关端口是开放的。

0