API Client extension for validate and transform requests / responses using pydantic.
Project description
Python API Client Pydantic Extension
Installation
pip install api-client-pydantic
Usage
The following decorators have been provided to validate request data and converting json straight to pydantic class.
from apiclient_pydantic import serialize, serialize_all_methods, serialize_request, serialize_response
# serialize incoming kwargs
@serialize_request(schema: Optional[Type[BaseModel]] = None, extra_kwargs: dict = None)
# serialize response in pydantic class
@serialize_response(schema: Optional[Type[BaseModel]] = None)
# serialize request and response data
@serialize(schema_request: Optional[Type[BaseModel]] = None, schema_response: Optional[Type[BaseModel]] = None, **base_kwargs)
# wraps all local methods of a class with a specified decorator. default 'serialize'
@serialize_all_methods(decorator=serialize)
Usage:
- Define the schema for your api in pydantic classes.
from pydantic import BaseModel, Field class Account(BaseModel): account_number: int = Field(alias='accountNumber') sort_code: int = Field(alias='sortCode') date_opened: datetime = Field(alias='dateOpened')
- Add the
@serialize_response
decorator to the api client method to transform the response directly into your defined schema.@serialize_response(List[Account]) def get_accounts(): ... # or @serialize_response() def get_accounts() -> List[Account]: ...
- Add the
@serialize_request
decorator to the api client method to translate the incoming kwargs into the required dict for the endpoint:@serialize_request(AccountHolder) def create_account(data: dict): ... # or @serialize_request() def create_account(data: AccountHolder): # data will be exactly a dict ... create_account(last_name='Smith', first_name='John') # data will be a dict {"last_name": "Smith", "first_name": "John"}
@serialize
- It is a combination of the two decorators@serialize_response
and@serialize_request
.- For more convenient use, you can wrap all APIClient methods with
@serialize_all_methods
.from apiclient import APIClient from apiclient_pydantic import serialize_all_methods from typing import List from .models import Account, AccountHolder @serialize_all_methods() class MyApiClient(APIClient): def decorated_func(self, data: Account) -> Account: ... def decorated_func_holder(self, data: AccountHolder) -> List[Account]: ...
Related projects
apiclient-pydantic-generator
This code generator creates a ApiClient app from an openapi file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for api-client-pydantic-1.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8aa87b36286fc1268034eac1ceaf31f000f06532a759f2379a715486164499f1 |
|
MD5 | d8b5512e99a3aba761810cca7c1ba6d5 |
|
BLAKE2b-256 | e1c7d59bf37c9924b31506d1a1c79c5c110138ceafe1af5b66898331877ba01a |
Close
Hashes for api_client_pydantic-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a724d7556ac447b44516f5b27720391a80334202e92a0b6fc7aca637be5074ea |
|
MD5 | 5500a3c17e6b869673a6f8ef4a474fe8 |
|
BLAKE2b-256 | e7b60d58ee0012f515a3e654dbc23022cf03eda78e8bdca8c61282d9adb98ab4 |