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()
        print("client", client, dir(client))

        print("client.operations", client.operations)
        print("client.paths", client.paths)
        print("client.functions", client.functions)
        print("client.tools", client.tools)  # get function call tools

        # 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.1.tar.gz (5.9 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.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi-httpx-client-0.2.1.tar.gz
  • Upload date:
  • Size: 5.9 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.1.tar.gz
Algorithm Hash digest
SHA256 7c16e2996ecd7f07215b5cbc8867d15a8ad9f69a032552bbf69a97fc448b6703
MD5 3ec87680c046a892531304edcf42e1cb
BLAKE2b-256 b3baaccb349a35b85af5cd354fa278035a5fc58bd2c65cce4ba78a35ba3b415e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_httpx_client-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a29b7a7c190b936f727656a9c48cc5e34205fb614323d4188341ea89f826fe13
MD5 22f77db372a92a36502101f25d4b037c
BLAKE2b-256 f82220d18214ee0e6365853dd94e4843db345fb5d9c3c52a4dbf04f17a021476

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