BaseApi
BaseApi
¶
Bases: Generic[ResponseBodyT]
Base class for all API endpoints.
Subclass from BaseApi
and define appropriate attributes from
the list below to create your own API client endpoint.
Make sure to add in the generic type for the expected response body, so that you can get a fully typed response object.
Attributes:
Name | Type | Description |
---|---|---|
url |
str
|
The URL of the API endpoint. |
method |
BaseHttpMethod
|
The HTTP method to be used for the request. |
auth |
BaseHttpClientAuth
|
Optional authentication to be used. |
request_params |
type[DictSerializableT] | None
|
The request parameters (query strings) type. Will be added to the URL. |
request_body |
type[DictSerializableT] | None
|
The request body type (for POST, PUT, PATCH requests). |
response_body |
type[ResponseBodyT]
|
The expected response body type. The HTTP response body will be serialized to this type. |
http_client |
BaseHttpClient | None
|
Optional HTTP client to be used if not using the default (HTTPx). Or if wanting to customize the default client. |
Raises:
Type | Description |
---|---|
ClientSetupError
|
If the class attributes are not correctly defined. |
Examples:
A ver basic example of a Cat Facts API definition:
import quickapi
@dataclass
class ResponseBody:
current_page: int
data: list[Fact]
class MyApi(quickapi.BaseApi[ResponseBody]):
url = "https://catfact.ninja/facts"
response_body = ResponseBody
Which can be used like this:
api = MyApi()
response = api.execute()
assert isinstance(response.body, ResponseBody)
Source code in quickapi/api.py
Python | |
---|---|
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
|
execute(request_params=None, request_body=None, http_client=None, auth=USE_DEFAULT)
¶
Validate and execute the API request, then validate and return the typed response.
You can optionally override the request parameters, request body, HTTP client and authentication. Otherwise, default values from the class attributes (if defined) will be used.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request_params |
DictSerializableT | None
|
Optional request parameters to be sent with the request. |
None
|
request_body |
DictSerializableT | None
|
Optional request body to be sent with the request. |
None
|
http_client |
BaseHttpClient | None
|
Optional HTTP client to be used for sending the request. |
None
|
auth |
BaseHttpClientAuth
|
Optional authentication to be used for the request. |
USE_DEFAULT
|
Returns:
Type | Description |
---|---|
BaseResponse[ResponseBodyT]
|
Response object containing the client response and the parsed response body. |
Raises:
Type | Description |
---|---|
HTTPError
|
If the response status code is not 200. |
RequestSerializationError
|
If the request parameters or body cannot be serialized. |
ResponseSerializationError
|
If the response body cannot be serialized. |
Source code in quickapi/api.py
Python | |
---|---|
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
|