Ubuntu上Swagger测试如何进行

2025年8月22日 互联网

在Ubuntu上进行Swagger测试，主要有以下两种方式：

一、使用Swagger UI手动测试

  1. 安装Swagger UI

    • Docker方式：安装Docker后，拉取镜像并运行容器： 
      sudo apt install docker.io
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express

      访问 http://localhost:8080 即可使用。

    • Node.js方式：安装Node.js后，通过npm安装Swagger UI Express，创建Express应用并集成Swagger文档： 
      sudo apt install nodejs npm
npm install swagger-ui-express

      编写代码加载Swagger文档（如YAML/JSON文件），启动服务后访问 http://localhost:3000/api-docs。

  2. 测试API接口

    • 在Swagger UI界面中，选择需测试的接口，点击“Try it out!”，输入参数后点击“Execute”，查看响应结果。

二、使用自动化测试工具

  1. 安装依赖
    安装Node.js、npm及测试框架（如Mocha、Chai）和Swagger解析库（如swagger-jsdoc）：

    sudo apt install nodejs npm
npm install mocha chai swagger-jsdoc supertest --save-dev

  2. 编写测试脚本

    • 创建测试文件（如test/api.test.js），通过swagger-jsdoc解析Swagger文档，使用supertest发送HTTP请求并断言结果： 
      const chai = require('chai');
const expect = chai.expect;
const request = require('supertest');
const app = require('../app'); // Express应用

describe('GET /users', () => {
  it('should return a list of users', async () => {
    const res = await request(app).get('/api/users');
    expect(res.status).to.equal(200);
    expect(res.body).to.be.an('array');
  });
});

  3. 运行测试
    在终端执行测试脚本：

    npx mocha test/api.test.js

注意事项

  • 确保API服务已启动且可访问，若需认证则在Swagger UI或请求头中添加认证信息。
  • 若使用Docker，需将Swagger文档文件挂载到容器中，或通过环境变量指定文档路径。
最新文章