Ir para o conteúdo

Base HTTP Connection

Parâmetros básicos para conexões HTTP com serviços externos.

Esta API define os campos comuns necessários para estabelecer conexões HTTP seguro e configurável para APIs externas, incluindo validações URLs automáticos e métodos HTTP permitidos.


Informações Gerais:

Tipo ID Módulo Categoria
1 httplib api

BaseHttpConnectionParams

Parâmetros:

  • url: HttpUrl URL completo e válido do terminal de serviço externo. Deve ser um URL HTTP ou HTTPS válido.
  • cabeçalhos: dict[str, str], opcional Dicionário de cabeçalhos HTTP adicionais a serem incluídos na solicitação. O padrão é Nenhum, o que significa cabeçalhos vazios.
  • método: ('GET', 'POST', 'PUT', 'DELETE', 'PATCH') Método HTTP a ser usado para a solicitação. O padrão é 'OBTER'.
  • body : ditado, opcional Corpo da solicitação no formato JSON. Aplicável apenas para métodos que suportam o corpo (POST, PUT, PATCH). Por padrão é Nenhum.
  • verify_ssl: bool Indica se o certificado SSL do servidor deve ser validado. Por padrão é True para conexões seguras.

Parâmetros de entrada:

Campo Tipo Obrigatório Descrição Valor padrão Exemplos
url HttpUrl URL completo do endpoint de serviço PydanticUndefined https://api.example.com/endpoint
headers Optional[dict[str, str]] Cabeçalhos HTTP adicionais a serem incluídos na solicitação None {"Authorization": "Bearer token", "Content-Type": "application/json"}
method Literal[GET, POST, PUT, DELETE, PATCH] Método HTTP a ser usado GET POST
body Optional[dict[str, Any]] Corpo JSON da solicitação None {"key": "value"}
verify_ssl bool Se deve validar o certificado SSL True True

Exemplo:

{
  "url": "https://api.example.com/endpoint",
  "headers": {
    "Authorization": "Bearer token"
  },
  "method": "POST",
  "body": {
    "key": "value"
  },
  "verify_ssl": true
}

Notas:

Esta classe herda de pydantic.BaseModel, que fornece validação Digitação automática e geração de esquema JSON. Os campos com restrições (como url e método) gerarão ValidationError se não atenderem com os critérios definidos.