api2jmx

Generate Apache JMeter JMX test scripts from OpenAPI/Swagger or Markdown API documentation.

5|1|Updated Feb 27, 2026
One-click install
npx skills add https://github.com/winhok/testkit --skill api2jmx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api2jmx
Source: https://github.com/winhok/testkit/tree/main/skills/api2jmx
Command: npx skills add https://github.com/winhok/testkit --skill api2jmx

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill helps teams automate the generation of Apache JMeter test scripts from API documentation, accelerating performance testing and ensuring consistency across endpoints and environments.

Core Features & Use Cases

  • OpenAPI/Swagger (YAML/JSON) and Markdown inputs are parsed into a unified API model and converted into JMeter test plans.
  • Generates a complete JMX file containing a TestPlan, per-endpoint ThreadGroups, HTTPSamplerProxy requests, and assertions, with data-driven and header support.
  • Suitable for automated pipelines where API specs evolve and performance tests need to be regenerated from updated docs.

Quick Start

Feed your API specification (OpenAPI/Swagger or Markdown) to the generator and save the produced JMX file.

Frequently Asked Questions about api2jmx

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate JMeter test scripts from OpenAPI specs?

You can generate JMeter test scripts from OpenAPI specs by parsing the YAML or JSON documentation into a unified API model, which is then converted into a complete JMX file containing ThreadGroups, HTTPSamplerProxy requests, and assertions.

Can I create JMX files from Markdown API documentation?

Yes, you can create JMX files from Markdown API documentation. The generator parses Markdown inputs into a unified API model and converts them into JMeter test plans with endpoints, parameters, request bodies, and assertions.

Does the generated JMX file include assertions and request bodies?

Yes, the generated JMX file includes assertions and request bodies. It produces a complete test plan containing per-endpoint ThreadGroups, HTTPSamplerProxy requests, parameters, and data-driven header support for performance testing.

Do I need pyyaml installed to convert Swagger to JMeter tests?

Yes, you need pyyaml installed to convert Swagger to JMeter tests. This dependency is required to parse the YAML-formatted OpenAPI or Swagger specifications into the unified API model for JMX generation.

What is the best way to automate performance testing when API specs evolve?

The best way to automate performance testing when API specs evolve is to integrate a generator into your pipeline that automatically regenerates JMX test plans from updated OpenAPI or Markdown documentation to ensure endpoint consistency.

Why use documentation-driven JMeter test generation instead of manual recording?

Documentation-driven JMeter test generation accelerates performance testing and ensures consistency across endpoints by directly parsing API specs into JMX files, eliminating the manual effort and potential errors of recording test plans.