OpenAPI to Locust Generator

A lightweight command-line utility that parses an OpenAPI specification (Swagger/OAS 3.0) and generates a clean, PEP8-compliant locustfile.py with auto-mocked query parameters and JSON request bodies.

Features

• Robust OpenAPI Parsing: Uses prance to resolve internal $ref links and complex structural schemas.
• Payload & Parameter Mocking: Automatically creates mock data structures based on property types (uuid, date-time, arrays, etc.) for GET, POST, PUT, and PATCH requests.
• Syntax Isolation: Automatically sanitizes operation descriptions, handles punctuation gracefully, and eliminates template gaps.

Install

pip install locust-openapi-generator
locust-openapi-generator openapi.json 

Local Installation & Setup

If you are developing locally on your laptop, follow these steps to isolate your dependencies and get started.

1. Clone the Repository

git clone [https://github.com/your-username/your-repo-name.git](https://github.com/your-username/your-repo-name.git)
cd your-repo-name

2. Create and Activate a Virtual Environment

Isolate your workspace packages using Python's built-in venv module. On macOS/Linux:

python3 -m venv .venv
source .venv/bin/activate

On Windows (Command Prompt):

python -m venv .venv
.venv\Scripts\Activate

On Windows (PowerShell):

python -m venv .venv
.\.venv\Scripts\Activate.ps1 

3. Install dependencies

Install the required tools directly via the requirements.txt manifest:

pip install --upgrade pip
pip install -r requirements.txt

Usage

You can run the script directly from your terminal by passing your OpenAPI JSON or YAML spec file.

Basic Generation

Generates a standard locustfile.py in your current directory:

python src/openapi_to_locust/generator.py path/to/openapi.json 

Custom Output Name

Change the target filename using the -o or --output flag:

python src/openapi_to_locust/generator.py path/to/openapi.yaml -o dynamic_load_test.py 

Powered by