How to convert YApi documentation to JMeter tests with swaggerjmx?

swaggerjmx supports YApi by accepting the JSON export from YApi as input. Use the CLI with the -i flag pointing to the YApi JSON file, and it will generate a JMX file ready for JMeter, similar to the Swagger conversion process.

Does swaggerjmx work with OpenAPI 3.0 specifications?

The README mentions Swagger URLs, typically OpenAPI 2.0. It's not explicitly stated if OpenAPI 3.0 is supported, so users might need to verify compatibility or use tools to downgrade specifications for conversion.

How to handle login for Swagger URLs in swaggerjmx?

For authenticated Swagger endpoints, swaggerjmx requires manually copying the JSON from the browser and saving it as a file, then using Demo_2 in Python or the CLI with the file path, as this tool doesn't automate login workflows.

swaggerjmx vs manual JMX scripting for performance testing?

swaggerjmx automates test generation from API docs, ideal for quick coverage and regression testing. Manual scripting is better for complex scenarios with custom logic, but swaggerjmx provides a faster start for basic load tests.

Can swaggerjmx generate data-driven tests in JMeter?

No, swaggerjmx focuses on generating basic HTTP request samplers from API specs. It does not automatically create data-driven elements like CSV data sets; these must be added manually in JMeter after generation.

How to integrate swaggerjmx into a CI/CD pipeline?

Use the CLI mode in pipeline scripts: run 'swaggerjmx -i -o ' after API updates. This ensures JMeter tests are regenerated automatically, keeping performance tests synchronized with API changes.

Open-Awesome

swaggerjmx

MITPythonv1.1.2

A Python tool that converts Swagger/OpenAPI and YApi documentation into JMeter JMX files for automated performance testing.

Visit Website GitHub

115 stars40 forks0 contributors

What is swaggerjmx?

swaggerjmx is a Python tool that automatically converts Swagger/OpenAPI and YApi documentation into JMeter JMX files. It solves the problem of manually writing and maintaining performance test scripts by generating them directly from API specifications, saving significant time for testing teams.

Target Audience

API testers, performance engineers, and developers who use JMeter for load testing and want to automate test script creation from existing API documentation.

Value Proposition

Developers choose swaggerjmx because it eliminates the tedious manual process of creating JMeter tests, supports both Swagger and YApi formats, and provides both programmatic and CLI interfaces for flexible integration into testing workflows.

Overview

Swagger/YApi convert jmx tool.

Use Cases

Best For

Automating JMeter test script generation from Swagger documentation
Converting YApi API documentation into performance test cases
Reducing manual effort in creating and maintaining API load tests
Integrating performance testing into CI/CD pipelines with API-first workflows
Generating comprehensive JMeter test plans covering all API endpoints
Teams using both Swagger/OpenAPI and YApi for API documentation

Not Ideal For

Projects using performance testing tools other than JMeter, like Gatling or k6
APIs documented in formats beyond Swagger or YApi, such as RAML or Postman collections
Teams requiring complex JMeter test logic with custom assertions, timers, or data parameterization

Pros & Cons

Pros

Dual Input Flexibility

Accepts both live Swagger URLs and local JSON files, enabling seamless workflow integration whether APIs are accessible online or offline, as shown in Demo_1 and Demo_2.

Multi-Format Support

Converts both Swagger/OpenAPI and YApi documentation, catering to teams with mixed API documentation tools without needing separate solutions.

Automation Efficiency

Automatically generates JMeter JMX files covering all documented endpoints, saving significant manual scripting time and reducing maintenance overhead.

Flexible Usage Modes

Offers both Python API and CLI interfaces, allowing easy scripting for automation pipelines or straightforward command-line use, as demonstrated in the README examples.

Cons

Authentication Handling Complexity

For APIs behind login, users must manually save JSON files from Swagger UI, as shown in Demo_2, which adds an extra step and reduces full automation for secured endpoints.

Basic Test Generation

Generates standard JMeter test plans but lacks advanced features like assertions, data-driven elements, or complex scenarios, requiring manual post-generation tweaks in JMeter.

Language Barrier in Documentation

The primary README is in Chinese, and while an English version exists, non-Chinese speakers might find initial setup and community resources less accessible.

Frequently Asked Questions

Related Projects

postman2jmx

Postman collection to Jmeter jmx file converter

Stars189

Forks102

Last commit2 months ago

fiddler2jmeter

JMeter脚本录制工具：将Fiddler/Charles转换为JMeter 4.0以上的脚本，并支持过滤功能 JMeter script recording tool: converts Fiddler / Charles into scripts above JMeter 4.0, and supports filtering function

Stars51

Forks20

Last commit1 year ago

har-convertor-jmeter-tool

Apache JMeter Plugin to convert a HAR file to a JMeter script and Record XML file

Stars25

Forks8

Last commit6 months ago

JMeter HAR Importer Plugin

A JMeter plugin that lets you select a HAR (HTTP Archive) file to import into JMeter

Stars19

Forks4