Skip to main content

A Python client for OpenAPI specifications using httpx

Project description

OpenAPI Client for Python

A Python implementation inspired by openapi-client-axios that provides a dynamic client for OpenAPI specifications. This implementation uses httpx for HTTP requests and Python's metaprogramming capabilities to dynamically generate a client.

Installation

pip install openapi-httpx-client

Usage

from openapiclient import OpenAPIClient
import asyncio

async def main():
    # Initialize the client with the OpenAPI definition
    api = OpenAPIClient(definition="https://petstore3.swagger.io/api/v3/openapi.json")

    try:
        # Initialize and get the dynamic client
        client = await api.init()

        # Call an operation using the generated method
        response = await client.getPetById(petId=1)

        # Print the response
        print(f"Status code: {response['status']}")
        print(f"Pet data: {response['data']}")
    finally:
        # Close the HTTP session
        await api.close()

if __name__ == "__main__":
    asyncio.run(main())

Features

  • Dynamic client generation using Python metaprogramming
  • Supports OpenAPI 3.0 and 3.1
  • Supports JSON and YAML specification formats
  • Supports specification loading from URL, file, or dictionary
  • Asynchronous API using httpx
  • Response format similar to axios (data, status, headers, config)

Author

lloydzhou (2025-02-27)

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

openapi-httpx-client-0.2.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapi_httpx_client-0.2.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file openapi-httpx-client-0.2.0.tar.gz.

File metadata

  • Download URL: openapi-httpx-client-0.2.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.2

File hashes

Hashes for openapi-httpx-client-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d58b7ec85833f12b551c0f677e7d1859573d85a11a32bb995b3ae2885297f895
MD5 2797cd2540a27d0f1c1aec8961d70ba7
BLAKE2b-256 ff68801b8504eb349a168e9ccfc260aaf57d17e67bc048d91773b55c6a897ce9

See more details on using hashes here.

File details

Details for the file openapi_httpx_client-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_httpx_client-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb68e7b3ad719aa56b5ca5d3cc0036dccd3ae07cf75db7c004adf86f52bf7f7
MD5 e6e9a82190ab3cd131a4bbdb6eb6ac22
BLAKE2b-256 2249177e91a1fee95f09ba09e04b63f7090b578103a1ddbe92c42641568d1514

See more details on using hashes here.

Supported by

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