rest

`app.common.http.rest`

Módulo de Python para consumir url's extenas, utilizando urllib3.

Para más información, te recomendamos leer la documentación del Proyecto.

el módulo app.common.http.base_api
https://urllib3.readthedocs.io/en/stable/user-guide.html
https://urllib3.readthedocs.io/en/stable/advanced-usage.html

`ClientApi`

Bases: BaseApiClient

Genera una instancia de urllib3.request para hacer peticiones a url's externas (Rest), se extiende de BaseApiClient.

Attributes:

Name	Type	Description
`_default_headers`	`dict[str, Any]`	un diccionario con la información de las cabeceras

`get(url, custom_headers=None)`

Realiza una petición de tipo GET.

Parameters:

Name	Type	Description	Default
`url`	`str`	la url/endpoint para recibir los datos	required
`custom_headers`	`dict[str, Any]`	un diccionario para establecer cabeceras adicionales	`None`

Warning

este metódo:

se necesitan más pruebas y ejemplos.

Returns:

Type	Description
`Optional[dict[str, Any]]`	Un diccionario con el estado del servicio

Examples:

1 2	`... self.get()`

`post(url, data, custom_headers=None)`

Realiza una petición de tipo POST.

Parameters:

Name	Type	Description	Default
`url`	`str`	la url/endpoint para enviar los datos	required
`data`	`dict[str, Any]`	un diccionario con la data a enviar	required
`custom_headers`	`dict[str, Any]`	un diccionario para establecer cabeceras adicionales	`None`

Warning

este metódo:

se necesitan más pruebas y ejemplos.

Returns:

Type	Description
`Optional[dict[str, Any]]`	Un diccionario con el estado del servicio

Examples:

1 2	`... self.post()`

`put(url, data, custom_headers=None)`

Realiza una petición de tipo PUT.

Parameters:

Name	Type	Description	Default
`url`	`str`	la url/endpoint para enviar los datos	required
`data`	`dict[str, Any]`	un diccionario con la data a actualizar	required
`custom_headers`	`dict[str, Any]`	un diccionario para establecer cabeceras adicionales	`None`

Warning

este metódo:

se necesitan más pruebas y ejemplos.

Returns:

Type	Description
`Optional[dict[str, Any]]`	Un diccionario con el estado del servicio

Examples:

1 2	`... self.put()`

`patch(uri, data=None, custom_headers=None)`

Realiza una petición de tipo PATCH.

`delete(url, custom_headers=None)`

Realiza una petición de tipo DELETE.

Parameters:

Name	Type	Description	Default
`url`	`str`	la url/endpoint para enviar los datos	required
`custom_headers`	`dict[str, Any]`	un diccionario para establecer cabeceras adicionales	`None`

Warning

este metódo:

se necesitan más pruebas y ejemplos.

Returns:

Type	Description
`Optional[dict[str, Any]]`	Un diccionario con el estado del servicio

Examples:

1 2	`... self.delete()`

`form_data(url, data, custom_headers=None)`

Realiza una petición de tipo POST, enviando los datos via form-urlencoded, se utiliza 'urlencode' para convertir el diccionario (data), en campos clave/valor.

Parameters:

Name	Type	Description	Default
`url`	`str`	la url/endpoint para enviar los datos	required
`data`	`dict[str, Any]`	un diccionario con la data a enviar	required
`custom_headers`	`dict[str, Any]`	un diccionario para establecer cabeceras adicionales	`None`

Warning

este metódo:

se necesitan más pruebas y ejemplos.

Returns:

Type	Description
`Optional[dict[str, Any]]`	Un diccionario con el estado del servicio ó `None`

Examples:

1 2	`... self.form_data()`