openapi-dynamic-client 0.1.0

Generic dynamic Python client for APIs described by OpenAPI specifications.

openapi-dynamic-client

Generic dynamic Python client for APIs described by OpenAPI specifications.

This package allows you to consume REST APIs from an OpenAPI/Swagger JSON file without generating static client code.

Features

• Dynamic operation discovery from OpenAPI
• Call endpoints by operationId
• Optional tag-scoped access through module proxies
• Automatic pagination helper
• JSON and CSV response support
• Works with local OpenAPI files or Python dictionaries

Installation

pip install openapi-dynamic-client

For local development:

git clone https://github.com/lfeabreu/openapiclient-lib.git
cd openapiclient-lib
pip install -e .

Basic Usage

from openapiclient import OpenAPIClient

api = OpenAPIClient.from_file("api-docs.json")

response = api.call(
    "listUsers",
    page=1,
)

print(response)

Listing operations

operations = api.list_operations()

for operation in operations:
    print(operation)

Calling operations by tag

users = api.module("users")

response = users.listUsers(page=1)
print(response)

Pagination

For APIs that return paginated responses with fields such as resultado, totalPaginas, and paginasRestantes:

for item in api.items("listUsers", max_pages=1):
    print(item)

Using a tag/module proxy:

users = api.module("users")

for item in users.items("listUsers", max_pages=1):
    print(item)

CSV responses

csv_bytes = api.csv("exportUsers")

with open("users.csv", "wb") as file:
    file.write(csv_bytes)

Project Structure

openapiclient/
├─ __init__.py
├─ base.py
├─ client.py
├─ exceptions.py
├─ openapi.py
├─ pagination.py
└─ proxy.py

Future features

• Dynamic pagination config (the current pagination implementation assumes fixed response field names).

License

MIT