linux

如何使用Swagger在Linux上测试API

小樊
35
2025-04-01 04:46:47
栏目: 智能运维

在Linux系统上使用Swagger测试API的步骤如下:

安装Swagger

  1. 安装Java环境:Swagger需要Java运行环境(JRE)或Java开发工具包(JDK)。你可以通过以下命令安装OpenJDK:
sudo apt update
sudo apt install openjdk-11-jdk
  1. 安装Maven:Swagger使用Maven进行构建和依赖管理。你可以通过以下命令安装Maven:
sudo apt install maven
  1. 下载并解压Swagger UI
wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.zip
unzip springfox-swagger-ui-2.9.2.zip
sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui
  1. 配置Swagger UI:编辑 /var/www/html/swagger-ui/index.html 文件,找到以下行并进行修改:
<script>
  window.onload = function() {
    // Begin Swagger UI call region
    const ui = SwaggerUIBundle({
      url: "http://petstore.swagger.io/v2/api-docs",
      dom_id: '#swagger-ui',
      deepLinking: true,
      presets: [
        SwaggerUIBundle.presets.apis,
        SwaggerUIStandalonePreset
      ],
      plugins: [
        SwaggerUIBundle.plugins.DownloadUrl
      ],
      layout: "StandaloneLayout"
    });
    // End Swagger UI call region
    window.ui = ui;
  };
</script>
  1. 启动Web服务器
sudo a2ensite default.conf
sudo systemctl restart apache2
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.baksudo nano /etc/nginx/sites-available/default

修改server块中的 rootindex 指令:

server {
  listen 80 default_server;
  listen [::]: 80 default_server;
  root /var/www/html;
  index index.html index.htm;
  server_name _;
  location / {
    try_files $uri $uri/ /index.html;
  }
}

保存并退出编辑器,然后重启Nginx:

sudo systemctl restart nginx

使用Swagger测试API

  1. 启动Swagger:在命令行中输入以下命令启动Swagger:
swagger
  1. 访问Swagger UI:在浏览器中访问 http://your_server_ip/swagger-ui,你将看到Swagger的欢迎页面。

  2. 测试API:在Swagger UI界面中,你可以点击“TRY IT OUT”按钮来测试API请求。输入必要的参数,然后发送请求并查看返回结果。

请注意,以上信息仅供参考,具体步骤可能因Linux发行版和具体需求而有所不同。

0
看了该问题的人还看了