Skip to content

API clients

ApiClient is responsible for sending request to an API based on the query.

Built-in API clients

Fake

FakeApiClient is ideal for prototyping and test.

It allows you to specify sample response from an API as data (dictionary, CSV, JSON) or generate it from the query itself.

From query

FakeApiClient supports specifying requested data types in a query.

4 types of data can be generated:

  • float
  • int
  • str
  • bool

From data

from garf.core.api_clients import FakeApiClient

fake_data = [
  {'field1': {'subfield': 1}, 'field2': 2},
  {'field1': {'subfield': 10}, 'field2': 2},
]
api_client = FakeApiClient(results=fake_data)

Instead of providing data as a variable you can read them from JSON or CSV.

from garf.core.api_clients import FakeApiClient

api_client = FakeApiClient.from_json('path/to/json')
api_client = FakeApiClient.from_csv('path/to/csv')

Note

You can simplify fetching fake data with FakeApiReportFetcher.

Options

FakeApiClient supports several options:

  • failure_rate - value from 0 to 1 to simulate API failure.
  • delay_seconds - delay before returning fake data.
  • n_rows - (for from_query option only) - specifies how many rows of data should be generated.
from garf.core.api_clients import FakeApiClient

api_client = FakeApiClient(
  options={'n_rows': 10, 'delay_seconds': 10, 'failure_rate': 0.5}
)

REST

REST API client is useful when you have a REST API available. Provide endpoint to get data from.

from garf.core.api_clients import RestApiClient

endpoint= 'https://api.restful-api.dev'
api_client = RestApiClient(endpoint=endpoint)

Note

You can simplify fetching from REST API with RestApiReportFetcher.

Create API client

If you want to get reports from different APIs you need to implement new API Client.

Please refer to development docs to learn more.