response

`app.common.http.response`

Una función para convertir las respuestas en objetos JSON de cada módulo/vista del BackEnd, y devolverlos al cliente.

`response_xml(status_code=200, data=None)`

Una función para convertir las respuestas en objetos XML de cada módulo/vista del BackEnd.

Parameters:

Name	Type	Description	Default
`status_code`	int, optional)`	codigo de estado HTTP, por defecto `200`.	`200`
`data`	object\|Any)`	un objeto de tipo `XML`.	`None`

Returns:

Type	Description
`Response`	un objeto de tipo `Response`

Examples:

async def get(self, id: Optional[str] = None):
    ...

    return response_xml(200, '<root><info>all right!</info></root>')

`response(status_code=200, message='success', data=None, error_code=400, error=None)`

Una función para convertir las respuestas en objetos JSON de cada módulo/vista del BackEnd.

Parameters:

Name	Type	Description	Default
`status_code`	`int`	codigo de estado HTTP, por defecto `200`.	`200`
`message`	`str`	mensaje descriptivo de la respuesta, por defecto `"success"`.	`'success'`
`data`	`dict[str, Any]`	un diccionario/objeto con los datos de la respuesta. por defecto `None`.	`None`
`error_code`	`int optional`	codigo de error (opcional). por defecto `400`.	`400`
`error`	`dict[str, Any] \| str`	un diccionario/objeto/string (opcional) con información del posible error, por defecto `None`.	`None`

Notes

esta función omite deliberadamente el campo data, en caso de que se envíe el campo error.

Returns:

Type	Description
`ORJSONResponse`	un objeto de tipo `ORJSONResponse`

Examples:

async def get(self, id: Optional[str] = None):
    ...

    return response(200, HTTPStatus.SUCCESS, {"info": "all right!"})

    # ó de la forma
    return response(400, HTTPStatus.UNEXPECTED_ERROR, error=str(e))

`response_raw(status_code=200, data=None)`

Una función para devolver una respuesta personalizada de cada módulo/vista del BackEnd.

Parameters:

Name	Type	Description	Default
`status_code`	int, optional)`	codigo de estado HTTP, por defecto `200`.	`200`
`data`	object\|Any)`	un objeto de cualquier tipo	`None`

Notes

Tenga en cuenta de que el código http y la data enviada, no es validada, antes de devolver la respuesta al cliente.

Returns:

Type	Description
`Response`	un objeto de tipo `Response`

Examples:

async def get(self, id: Optional[str] = None):
    ...

    return response_raw(200, 'OK')