Ir para o conteúdo

HTTP Response Artifact

Modelo estruturado para representar uma resposta HTTP da biblioteca de solicitações.


Informações Gerais:

Tipo ID Módulo Categoria
100 httplib artifact

HttpResponseArtifact

Parâmetros:

  • url: str, opcional URL final solicitado, após redirecionamentos.
  • método: str, opcional Método HTTP usado para a solicitação.
  • status_code: int, opcional Código de status HTTP retornado pelo servidor.
  • razão: str, opcional Frase de motivo retornada pelo servidor.
  • ok: bool, opcional Se a resposta foi bem-sucedida (status < 400).
  • decorrido: float, opcional Tempo em segundos que a solicitação demorou.
  • cabeçalhos: dict[str, str], opcional Cabeçalhos de resposta normalizados.
  • request_headers: dict[str, str], opcional Cabeçalhos enviados com a solicitação.
  • body: ditado, lista, str, opcional Corpo de resposta.
  • body_preview: ditado, lista, str, opcional Corpo processado para visualização segura.
  • encoding: str, opcional Codificação declarada pelo servidor.
  • codificação_aparente: str, opcional Codificação detectada heuristicamente por solicitações.
  • erro: str, opcional Mensagem de erro se a solicitação falhar.

Parâmetros de entrada:

Campo Tipo Obrigatório Descrição Valor padrão Exemplos
url Optional[str] URL final solicitado, após redirecionamentos. None -
method Optional[str] Método HTTP usado para emitir a solicitação. None -
status_code Optional[int] Código de status HTTP retornado pelo servidor. None -
reason Optional[str] Frase de motivo retornada pelo servidor. None -
ok Optional[bool] Se a resposta foi bem-sucedida (status < 400). None -
elapsed Optional[float] Tempo em segundos que a solicitação levou para ser concluída. None -
headers Optional[dict[str, str]] Cabeçalhos de resposta normalizados para pares de strings simples. None -
request_headers Optional[dict[str, str]] Cabeçalhos que foram enviados com a solicitação HTTP. None -
body Optional[Any] Corpo de resposta limitado pelas salvaguardas do servidor. None -
body_preview Optional[Any] Corpo processado para exibição segura (por exemplo, listas truncadas). None -
encoding Optional[str] Codificação declarada pelo servidor para a resposta. None -
apparent_encoding Optional[str] Codificação detectada heuristicamente por solicitações. None -
error Optional[str] Mensagem de erro quando a solicitação falhou. None -

Exemplo:

{
  "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 os principais detalhes de uma resposta HTTP, facilitando a análise e depuração de interações com APIs externo. Os campos são opcionais para lidar com respostas parciais ou erros de conexão.