Skip to main content

Provides the basic setup of an API mockserver.

Project description

OAPI2MOCKSERVER

What does it do

It creates expectations for mockserver based on an OpenAPI2 yaml.

If no scenarios are provided, it creates expectations for all endpoints with the first status-code defined. If example values are given in contract, these values will be used for response body.

If scenarios are provided, they must match the defined endpoints in the OpenAPI2 file.

Usage

start a mockserver: docker run -it --rm -P jamesdbloom/mockserver

Create expectations: oapi2mockserver mock localhost:<port_of_mockserver_docker_container> <path_to_open_api_2_contract_yaml>

Scenario Parameter

-s json of scenarios to push to the mockserver

Example: oapi2mockserver mock localhost:32768 foo.yaml -s '{"scenarios":[["\/v1\/foo\/{id}","get","200", "{\"foo\":\"bar\"}", "application/json"]]}'

This pushes one scenario to mockserver with path /v1/foo/{id}, operation get, expected status-code 200, expected response-body {"foo":"bar"} and expected response Content-Type header application/json

Response-Body and Content-Type are optional and will be generated out of the contract if not given. If the Response-Body is a json, it will be validated against the schema defined in the contract before the scenario will be send to mock-server. Also the Content-Type header needs to be defined in produces part of contract before the scenario will be send to mock-server.

Development

run current development state:

  • cd into package root directory
  • install dependencies with pip3 install -r requirements.txt (just before first run or after adding new dependencies)
  • run python3 run.py mock <url_to_mockserver> <path_to_open_api_2_contract_yaml>

Tests

cd into package root directory and run python3 -m unittest discover -s tests -v

Build

cd into package root directory and run pip3 install ./

Upload to pypi.org

WARNING: This will overwrite the current version on pypi.org!

raise version in setup.py, then run ./upload

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

oapi2mockserver-0.0.14.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

oapi2mockserver-0.0.14-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file oapi2mockserver-0.0.14.tar.gz.

File metadata

  • Download URL: oapi2mockserver-0.0.14.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for oapi2mockserver-0.0.14.tar.gz
Algorithm Hash digest
SHA256 bcb0664ecfb7412ced686de381c23e826c563c5a3e1afe3ab3de3a5a08cc2f16
MD5 0b9dd641965403be3579b315feaf878e
BLAKE2b-256 02c7c58ebf94f9d6e9e275ef9fda3d55283f37ea9bad8fb5793594fd91bd4ea4

See more details on using hashes here.

File details

Details for the file oapi2mockserver-0.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for oapi2mockserver-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 13470c92ad2b24bfe343f2f64f5465fbe20e8a5ac3181cc6d530db50350269b2
MD5 270ee0aca175d23735f217bad253e53a
BLAKE2b-256 669d50e19f74e9b60b27d61a033355ec6c9bc0d3d4309ad8eabb768a79e98924

See more details on using hashes here.

Supported by

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