Module src.ApiRequest.ApiRequest

Classes

class ApiRequest

Request Object for RestApi requests

ApiRequest class represent a request object ApiRequest instances are generated by RequestFactory classes There is no reason to create ApiRequestInstance out of a RequestFactory instance

Methods

def copy(self)

def get_request_params(self)

return request parameters and end_url reprensented what was passed to the set_request() method

def get_response(self)

Execute request and return a Request instance(requests library)

def set_config(self, config: Config)

Set request configuration with a Config instance to prepare the request

Arguments

config(Required):

Config instance
--> see Config documentation

def set_request(self, end_url: str = None, params: dict = None)

Set end_url and params request arguments to prepare the request

Arguments

end_url(Optional): String. Complete base_url request argument (from set_config) ex

    base_url = "https://api/"
    end_url = "end_of_url"

    --> url = "https://api/end_of_url"

params(Optional): Dict. Parameters of the request url ex: params = {"plan":"Tier_one"}

    --> url = "https://api/end_of_url?plan=Tier_one"

Multiple parameters can be provided by key/value pairs in this dict