概览
这个 打开api- to- k6 寄存器是一个旨在简化 k6 脚本编写过程的工具. 它从 OpenAPI 规格生成一个 TypeScript 客户端, 您可以在您的 k6 脚本中导入到 方便的调用您的端点,并在您的 IDE 中自动完成 .
这样可以让开发者根据已有的API轻松创建性能测试 OpenAPI 文档.
它与客户端一起,还生成了样本 k6 脚本,作为如何使用客户端的例子.
生成的客户端会输出一个类别,其中包含OpenAPI规格中每个端点的方法. 您可以创建 并使用方法调用终点.
要查看生成客户端和样本脚本的示例, 请检查 实例 目录.
开始
-
通过以下方式在全球安装该工具:
npm install -g @grafana/openapi-to-k6 -
要开始使用此工具, 要么给您的 OpenAPI schema 文件提供路径, 要么为您的 OpenAPI schema 提供 URL 和您想要生成客户端文件的输出路径 :
openapi-to-k6 <path-to-openapi-schema | url-to-openapi-schema> <output path>这将生成一个 TypeScript 客户端和相应的目录中的样本 k6 脚本 .
您也可以提供可选旗帜
--include-sample-script生成样本 k6 脚本 与客户.
💡 说明:该工具既支持JSON格式,也支持OpenAPI schemas格式.
选项
以下是该工具所支持的一些配置选项:
-
--mode或者说-m:指定生成客户端所使用的模式。 有以下备选方案:single: 如果没有指定, 则使用默认模式 。 它将 TypeScript 客户端生成为单一文件,其中包含所有类型和执行在一个文件中.split: 此模式将类型和执行拆分为单独的文件.tags: 此模式会根据标签拆分您的 OpenAPI 计划, 并为每个标签生成单独的客户端 。 如果一个路由没有设置标签,则可以在default.ts文档.
要检查每个模式的输出外观, 请检查 实例 目录.
-
--only-tags: 过滤生成的客户端, 只包含您 OpenAPI schema 中带有特定标记的路由 。 可以指定多个标记,以包括匹配其中任何一个标记的路线. 没有标记的路线将被排除在外. 这对生成只包含您需要的端点的焦点客户端很有用.例如:
openapi-to-k6 <path-to-openapi-schema> <output path> --only-tags ItemsHeader将生成仅包含路径的客户端ItemsHeader标签。 您可以通过使用多个标签指定多个标签--only-tags标记或以空格分隔:--only-tags tag1 --only-tags tag2。 。 。 . -
--disable-analytics: 禁用匿名用途分析报告. 您也可以设置环境变量DISABLE_ANALYTICS=true以禁用分析. -
--include-sample-script: 生成样本 k6 脚本. 生成的样本脚本使用OpenAPI schema请求中定义的例子,使脚本可用出框. 如果不定义示例,它将使用Faker生成随机数据. -
--verbose或者说-v: 启用动词日志可以看到更详细的日志输出. -
--help或者说-h: 显示帮助消息 .
地方发展
- 清除仓库 :
git clone https://github.com/grafana/openapi-to-k6
- 安装依赖性 :
npm install
- 从源头运行 SDK 生成器 :
npm run dev <path-to-openapi-schema> <output path>
这将生成相应的目录中的 SDK 文件 .
- 在您的 k6 脚本中导入并使用以下命令运行脚本 :
k6 run <path-to-k6-script>.ts
运行 E2E 测试
我们有一些端到端的测试,以确保生成的SDK作品如所预期. 为了进行这些测试:
- 导航到测试目录 :
cd tests/e2e/
- 使用 Mokoon CLI 启动模拟服务器, 这将为 OpenAPI 规格定义的终点创建模拟服务器 . 这将在背景的 Docker 容器中运行模拟服务器 :
docker run -v ./schema.json:/tmp/schema.json -p 3000:3000 mockoon/cli:latest -d /tmp/schema.json
- 假设您已经遵循了之前的步骤并设置了环境,您可以通过使用:
npm run dev -- ./schema.json ./sdk.ts
- 运行 k6 脚本 :
k6 run ./K6Script.ts
包装
- 运行命令
npm run build来包装项目以供分发. - 本地安装编译软件包
npm install .或者说npm install -g .。 。 。 . - 使用 CLI :
k6-sdkgen <path-to-openapi-schema> <output path>。 。 。 .
释放
要发布该工具的新版本,在GitHub上创建以新版本编号为标签的新版本(例如, 0.1.0)和发行笔记. 在发行创建后,GitHub Actions将自动将工具包入并发布到npm.
特别提及开源库 阴性 用于生成 TypeScript 客户端.