Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paolorechia/rest-api-client
Rest API Client
https://github.com/paolorechia/rest-api-client
api api-client chuck-norris dynamic notion pantry pydantic python3 rest sdk typing
Last synced: 12 days ago
JSON representation
Rest API Client
- Host: GitHub
- URL: https://github.com/paolorechia/rest-api-client
- Owner: paolorechia
- License: mit
- Created: 2021-07-10T21:51:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-28T22:08:47.000Z (about 3 years ago)
- Last Synced: 2024-04-22T20:06:27.690Z (7 months ago)
- Topics: api, api-client, chuck-norris, dynamic, notion, pantry, pydantic, python3, rest, sdk, typing
- Language: Python
- Homepage:
- Size: 698 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Rest API Client
-----
Glues pydantic and httpx to provide a simple REST API client, with dynamic generated methods.
It supports both synchronous and asynchronous formats.
Roadmap:
- Auto generate models from OpenAPI (3) Spec
- Import Postman Collection
- Export generated source code
---
### Installation
```bash
pip install py_rest_api_client
```
### Usage
Here's a set of examples you can use to understand how to use the library.
They all correspond to test cases under `test/integration/`.
Please note that authentication in general is provided by `httpx_auth`,
with the exception of a simple Bearer token.
#### Notion - Bearer Token Auth
```python
auth = BearerHeaderToken(bearer_token=notion_token)
client = httpx.Client(auth=self.auth)
api = RestAPI(
api_url="https://api.notion.com/v1",
driver=client,
endpoints=[
Endpoint(name="search", path="/search", method=HTTPMethod.POST),
],
custom_headers={"Notion-Version": "2021-05-13"},
)
api.search(data={"query": "Test page"})
```
#### Pantry
```python
api = RestAPI(
api_url="https://getpantry.cloud/apiv1",
driver=client,
# One can also pass endpoints to the constructor
endpoints=[
Endpoint(name="get_pantry", path="/pantry/{pantry_id}"),
Endpoint(
name="get_basket",
# Path parameters can be provided in the format {variable_name}
path="/pantry/{pantry_id}/basket/{basket_id}",
),
Endpoint(
# 'create_' is interpreted as POST
name="create_basket",
path="/pantry/{pantry_id}/basket/{basket_id}",
),
Endpoint(
# 'update_' is interpreted as PUT
name="update_basket",
path="/pantry/{pantry_id}/basket/{basket_id}",
),
Endpoint(
name="delete_basket",
path="/pantry/{pantry_id}/basket/{basket_id}",
),
],
)
pantries = api.get_pantry(pantry_id="123")
# Create/update/patch methods have an additional parameter called data
# Which is passed as the BODY of the request
api.create_basket(pantry_id="123", basket_id="234", data={"key": "value"})
api.update_basket(pantry_id="123", basket_id="234", data={"key2": "value2"})
basket = api.get_basket(pantry_id="123", basket_id="234")
api.delete_basket(pantry_id="123", basket_id="234")
```
If pantry supported PATCH, we would declare the endpoint as:
```python
Endpoint(
name="patch_basket", # No alias for patch exists
path="/pantry/{pantry_id}/basket/{basket_id}",
),
```
#### Async methods
By default, async methods are created with the prefix `_async`.
For instance:
```python3
await api.async_get_pantry(pantry_id="123")
await api.async_create_basket(
pantry_id="123", basket_id="234", data={"key": "value"}
)
await api.async_update_basket(
pantry_id="123", basket_id="234", data={"key2": "value2"}
)
await api.async_get_basket(pantry_id="123", basket_id="234")
await api.async_delete_basket(pantry_id="123", basket_id="234")
```
#### Chuck Norris
```python
CHUCK_BASE_URL = "https://api.chucknorris.io/jokes"
# Imports
from pydantic import BaseModel, HttpUrl
from rest_api_client.lib import RestAPI, Endpoint, HTTPMethod
import httpx
# Optionally declare your model classes
class JokeModel(BaseModel):
id: str
created_at: str
updated_at: str
icon_url: str
categories: list
url: str
value: str
# Declare your API endpoints
endpoints = [
# Fully descriptive declaration.
Endpoint(
name="get_joke",
path="/random",
method=HTTPMethod.GET,
model=JokeModel,
query_parameters=[("category", str)],
),
# No model provided, result comes back as a dictionary.
Endpoint(
name="get_categories",
path="/categories",
method=HTTPMethod.GET,
),
# Omit HTTP Method, it gets inferred from the endpoint name.
Endpoint(name="get_search", path="/search", query_parameters=[("query", str)]),
]
# Instantiate your HTTP client session. Should also work with requests
with httpx.Client() as client:
api = RestAPI(api_url=CHUCK_BASE_URL, driver=client)
api.register_endpoints(endpoints)
joke = api.call_endpoint("get_joke")
joke2 = api.get_joke()
categories = api.get_categories()
search = api.get_search(query="something")
print(joke)
print(joke2)
print(search)
```