openapi-httpx-client 0.3.0

A Python client for OpenAPI specifications using httpx

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']}")

        # Call an operation using the generated method
        response = await client('getPetById', petId=1)
        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)