Skip to main content

Convert apidoc data to JSON testcases for HttpRunner.

Project description


Convert apidoc data to JSON testcases for HttpRunner.




To see apidoc2runner version:

$ python -V

To see available options, run

$ python -h
usage: [-h] [-V] [--log-level LOG_LEVEL]
               [apidoc_testset_file] [-- output_dir] [-- output_file_type]

Convert apidoc testcases to JSON testcases for HttpRunner.

positional arguments:
  apidoc_testset_file  Specify apidoc testset file.
  -- output_dir   Optional. Specify converted JSON testset folder.
  -- output_file_type  Optional. Generate file format , default json.

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show version
  --log-level LOG_LEVEL Specify logging level, default is INFO.


In most cases, you can run apidoc2runner like this:

$ python3 tests/data/test.json --output_dir tests/apidoc2runner --output_file_type yaml
INFO:root:Generate JSON testset successfully: output.json

As you see, the first parameter is apidoc source file path, and the second is converted JSON file path.

The output testset file type is detemined by the suffix of your specified file.

If you only specify apidoc source file path, the output testset is in JSON format by default and located in the same folder with source file.

$ python3 tests/data/test.json
INFO:root:Generate JSON testset successfully: test/test.output.json

generated testset

generated JSON testset output.json shows like this:

        "test": {
            "name": "/api/v1/Account/Login",
            "request": {
                "method": "POST",
                "url": "",
                "headers": {
                    "Content-Type": "application/json"
                "json": {
                    "UserName": "test001",
                    "Pwd": "123",
                    "VerCode": ""
            "validate": []



Project details

Release history Release notifications

Download files

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

Files for apidoc2runner, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size apidoc2runner-0.0.1-py3-none-any.whl (10.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size apidoc2runner-0.0.1.tar.gz (7.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page