Saltar a contenido

HTTP Response Artifact

Modelo estructurado para representar una respuesta HTTP de la librería requests.


Información General:

Tipo ID Módulo Categoría
100 httplib artifact

HttpResponseArtifact

Parámetros:

  • url : str, optional URL final solicitada, después de redirecciones.
  • method : str, optional Método HTTP usado para la solicitud.
  • status_code : int, optional Código de estado HTTP retornado por el servidor.
  • reason : str, optional Frase de razón retornada por el servidor.
  • ok : bool, optional Si la respuesta fue exitosa (status < 400).
  • elapsed : float, optional Tiempo en segundos que tomó la solicitud.
  • headers : dict[str, str], optional Headers de la respuesta normalizados.
  • request_headers : dict[str, str], optional Headers enviados con la solicitud.
  • body : dict, list, str, optional Cuerpo de la respuesta.
  • body_preview : dict, list, str, optional Cuerpo procesado para visualización segura.
  • encoding : str, optional Encoding declarado por el servidor.
  • apparent_encoding : str, optional Encoding detectado heurísticamente por requests.
  • error : str, optional Mensaje de error si la solicitud falló.

Parámetros de entrada:

Campo Tipo Requerido Descripción Valor por defecto Ejemplos
url Optional[str] Final URL requested, after redirects. None -
method Optional[str] HTTP method used to issue the request. None -
status_code Optional[int] HTTP status code returned by the server. None -
reason Optional[str] Reason phrase returned by the server. None -
ok Optional[bool] Whether the response was successful (status < 400). None -
elapsed Optional[float] Time in seconds that the request took to complete. None -
headers Optional[dict[str, str]] Response headers normalised to simple string pairs. None -
request_headers Optional[dict[str, str]] Headers that were sent with the HTTP request. None -
body Optional[Any] Response body limited by the server safeguards. None -
body_preview Optional[Any] Body processed for safe display (e.g. truncated lists). None -
encoding Optional[str] Encoding declared by the server for the response. None -
apparent_encoding Optional[str] Encoding detected heuristically by requests. None -
error Optional[str] Error message when the request failed. None -

Ejemplo:

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "status_code": 200,
  "reason": "OK",
  "ok": true,
  "elapsed": 0.123,
  "headers": {
    "Content-Type": "application/json"
  },
  "request_headers": {
    "Authorization": "Bearer token"
  },
  "body": {
    "key": "value"
  },
  "body_preview": {
    "key": "value"
  },
  "encoding": "utf-8",
  "apparent_encoding": "utf-8",
  "error": null
}

Notas:

Este modelo captura los detalles clave de una respuesta HTTP, facilitando el análisis y la depuración de interacciones con APIs externas. Los campos son opcionales para manejar respuestas parciales o errores de conexión.