Skip to main content

Tool for testing API endpoints that have Open API / Swagger specifications using locustio

Project description

swagger2locustio

swagger2locustio - a tool for testing API endpoints that have Open API / Swagger specifications using locustio.

It generates locustfile.py from the application schema.

Supported specification versions:

  • Swagger 2.x

Installation

To install swagger2locustio via pip run the following command:

pip install swagger2locustio

Usage

Command line options

usage: swagger2locustio [-h] -f SWAGGER_FILE [-r RESULTS_PATH] [-v]
                        [-o {get,post,put,patch,delete,head,options,trace} [{get,post,put,patch,delete,head,options,trace} ...]]
                        [--paths-white PATHS_WHITE [PATHS_WHITE ...]] [--paths-black PATHS_BLACK [PATHS_BLACK ...]] [--tags-white TAGS_WHITE [TAGS_WHITE ...]]
                        [--tags-black TAGS_BLACK [TAGS_BLACK ...]]

optional arguments:
  -h, --help            show this help message and exit
  -f SWAGGER_FILE, --swagger-file SWAGGER_FILE
                        path to swagger file (default: None)
  -r RESULTS_PATH, --results-path RESULTS_PATH
                        path to store locustfile.py (default: generated)
  -v, --verbose         verbose (default: False)
  -o {get,post,put,patch,delete,head,options,trace} [{get,post,put,patch,delete,head,options,trace} ...], --operations {get,post,put,patch,delete,head,options,trace} [{get,post,put,patch,delete,head,options,trace} ...]
                        operations to use in api testing (default: ['get'])
  --paths-white PATHS_WHITE [PATHS_WHITE ...], --pw PATHS_WHITE [PATHS_WHITE ...]
                        paths to use in api testing (default: [])
  --paths-black PATHS_BLACK [PATHS_BLACK ...], --pb PATHS_BLACK [PATHS_BLACK ...]
                        paths not to use in api testing (default: [])
  --tags-white TAGS_WHITE [TAGS_WHITE ...], --tw TAGS_WHITE [TAGS_WHITE ...]
                        tags to use in api testing (default: [])
  --tags-black TAGS_BLACK [TAGS_BLACK ...], --tb TAGS_BLACK [TAGS_BLACK ...]
                        tags to use in api testing (default: [])

Contributing

Please, see the CONTRIBUTING.md file for more details.

License

The code in this project is licensed under MIT license. By contributing to swagger2locustio, you agree that your contributions will be licensed under its MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swagger2locustio-0.0.4.tar.gz (34.7 kB view hashes)

Uploaded Source

Built Distribution

swagger2locustio-0.0.4-py3-none-any.whl (52.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page