fitrequest 0.7.1

Python class that allow to create client for REST API with dynamic code generation

FitRequest

This module allows you to write REST api client with automatic code generation.

Example of implementation: SkillCorner Python client for SkillCorner API.

Help

See documentation for more details.

Installation

pip install fitrequest

A simple example

from fitrequest.client import FitRequest


class RestApiClient(FitRequest):
    base_url = "http://base_api_url"
    base_client_name="rest_api"
    _docstring_template = 'GET request on endpoint: {endpoint}\nDocs URL anchor: http://base_api_url/docs/{docs_url_anchor}'
    _methods_binding = [
        {
            'name': 'get_item',
            'endpoint': '/items/{}',
            'docs_url_anchor': 'items/items_list',
            'resource_name': 'item_id',
        }
    ]

This is a simple definition of a subclass of FitRequest object. By instanciating this class, we can do the following:

my_client = RestApiClient()
response = my_client.get_item(item_id=3)

response variable will hold the value of the JSON response of the following HTTP request:

GET http://base_api_url/items/3

Subclass definition

MethodDetails and methods_binding

MethodDetails is a dataclass that holds the following attributes:

• name: the name of the method that will be created in the subclass of FitRequest
• endpoint: the endpoint of the request
• docstring: the docstring of the method that will be created in the subclass of FitRequest
• exec_method: the name of the method that will be executed to retrieve the response
• extra_params: the list of named arguments to add to the method signature
• raise_for_status: wether to raise exception for response status code >= 400 and < 600
• response_key: the key of the JSON response that will be returned by the method
• resource_name: the name of the arg that will be used in the definition of the python method and sent as a path or query parameter in the request

_methods_binding is almost a list of MethodDetails (as dict) that will be used to create the methods in the subclass of FitRequest.

The methods can be extended with a docstring template in which you can use any other method attribute. You can also have all the methods starting with 'get' duplicated as a save method starting with 'get_and_save' taking a filepath argument and dumping the data into a file.

For the moment, the generation of methods supports only one query or path parameters. If an endpoint requires more variables in its definition, you will need to actually write the method. For example, it is not possible to send a request to the following endpoint with the current version of FitRequest:

GET http://base_api_url/path/to/resource/{resource_id}/subresource/{subresource_id}

It will be a topic for a future release.

_build_final_url method

This method is used to build the final url of the request. Sometimes, you may need to add some extra information in the url before making the query. For example, you may need to add a token in the url. Here is a simple example:

    def _build_final_url(self, endpoint: str, **kwargs) -> str:
            return f'{self.base_url}{endpoint}?token={self.token}'

Authentication

Basic authentication

Basic authentication is supported by FitRequest. You just need to override the following method to your subclass of FitRequest:

from requests.auth import HTTPBasicAuth

    def _authenticate(self) -> HTTPBasicAuth:
        return HTTPBasicAuth(self.username, self.password)

This will set the auth attribute of the request's session.

Header based authentication

Some API requires extra headers to be set in the request. If you need to do so, you will have to override the session property in your subclass of FitRequest:

from requests import Session

    @property
    def session(self) -> Session:
        session = super().session
        session.headers['APIKey'] = self.api_key
        return session

Contact

You can contact Skillcorner Team at: [e-mail].