Package wrapipy

Wrapipy provides:

• a Pythonic wrapper WrAPI around a Swagger 2.0 API documentation object that allows to conveniently send requests to the API's endpoints and receive their responses,
• and a Pydantic specification of the documentation object, SwaggerDoc, which is a relaxed model of Swagger 2.0 directly parseable using the build-in json library.

Basic Usage

Parse a Swagger JSON File

from wrapipy import SwaggerDoc
import json

with open("path_to_swagger", "r") as f:
    data = json.load(f)
swagger = SwaggerDoc(**data)

Send Requests to an API

from wrapipy import WrAPI

api = WrAPI(swagger)
r = api.request(
    "endpoint_path",
    {
        "query": {
            # query params here as key-value dicts
        },
        "path": "path_param",
        "payload": {
            # payload params here as key-value dicts
        }
    }
)

Full Example

from wrapipy import SwaggerDoc, WrAPI
import json

with open("path_to_swagger", "r") as f:
    data = json.load(f)
swagger = SwaggerDoc(**data)
api = WrAPI(swagger)
r = api.request(
    "endpoint_path",
    {
        "query": {
            # query params here as key-value dicts
        },
        "path": "path_param",
        "payload": {
            # payload params here as key-value dicts
        }
    }
)

Advanced Options: Resend Requests

The request method of WrAPI allows to specify an additional parameter retry_responses (default [429]). When a response from this list of response codes is received, it resend the request after wait_time seconds (default 0.1) until a different response is received or until there have been max_attempts attempts (default 100).

Sub-modules

wrapipy.swagger

Pydantic models of Swagger 2.0 components …

wrapipy.wrapi

The definition of the WrAPI API wrapper and related objects.