Note
This is a public alpha release, and therefore features and functionality may change and the software and documentation may contain technical bugs or other issues. If you discover any issues please consider registering a GitHub issue.
datasources.connectors.rest_api module¶
This module contains a data connector class for retrieving data via a REST API.
-
class
datasources.connectors.rest_api.
RestApiConnector
(location: str, api_key: Union[str, NoneType] = None, auth: Union[Callable, NoneType] = None)[source]¶ Bases:
datasources.connectors.base.DataCatalogueConnector
Data connector for retrieving data from a REST API.
-
get_data
(params: Union[Mapping[str, str], NoneType] = None)[source]¶ Retrieve the data from this source.
If the data is JSON formatted it will be parsed into a dictionary - otherwise it will be passed as plain text.
Parameters: params – Query parameters to be passed through to the data source API Returns: Data source data
-