swaggerjmx

swaggerjmx

English Document

Logo

Install

pip install -U swaggerjmx

Warehouse address

• github: https://github.com/Pactortester/swaggerjmx.git
• pypi: https://pypi.org/project/swaggerjmx

Community Address

• testerhome: https://testerhome.com/opensource_projects/swaggerjmx

Applicable scenarios

1. Since the writing of interface test scripts is time-consuming and requires continuous maintenance, it is time-consuming and labor-intensive, using this tool to generate interface test scripts in one click.
2. Swagger-ui interface document generates jmx file for jmeter use in one click.
3. The yapi interface document generates jmx files for jmeter to use in one click.

Function

1. Convert swagger-ui document to jmx file.
2. Convert yapi document to jmx file.

Code method

Demo_1

• You can directly access swagger_url (http://ip:port/v2/api-doc) If you do not need to log in, use the Demo_1 method to convert it.

 # -*- coding: utf-8 -*-

from swaggerjmx . convert import conversion
from swaggerjmx . settings import Settings as ST
#  swagger_url
ST . swagger_url = 'http://ip:port/v2/api-docs'
#  report_path
ST . report_path = 'jmx'
# 开始转换
conversion ()

Demo_2

• If you need to log in to access, you can copy the json information on the swagger_url page, save the json file, and convert it using the Demo_2 method.

 # -*- coding: utf-8 -*-

from swaggerjmx . convert import conversion
from swaggerjmx . settings import Settings as ST
#  swagger_url_json_path 
ST . swagger_url_json_path = 'test.json'
#  report_path
ST . report_path = 'jmx'
# 开始转换
conversion ()

Command line method

Preset parameters

(venv) lijiawei@bogon swaggerjmx % swaggerjmx -h
usage: swaggerjmx [-h] -i INPUT [-o OUTPUT]

Swagger or YApi convert jmx tool ! Created: Lijiawei. Version 1.1.0

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        The input swagger json file or swagger url.
  -o OUTPUT, --output OUTPUT
                        The output jmx file path(default jmx). If it exists, new endpoints will be overwrite.

How to use

swaggerjmx -i < path_to_swagger_json_or_swagger_url > -o < path_to_output_jmx >

swagger json example

swaggerjmx -i tests/data/swagger.json -o jmx

swagger url example

swaggerjmx -i https://ip:port/v2/api-docs -o jmx

screenshot:

1. Pass into the swagger-ui address in the red box

2. Generated jmx file

3. Show in jmeter

Trend Chart

Contributors

contribute

git clone [email protected]:Pactortester/swaggerjmx.git
cd swaggerjmx
pip install -e .

The above is an introduction to the basic usage of swaggerjmx.

If you find an error, or you have any suggestions for swaggerjmx, welcome to swaggerjmx Issues, thank you very much for your support. Your feedback and suggestions are invaluable and hope your involvement will help swaggerjmx do better.