Base HTTP Connection
Parámetros base para conexiones HTTP a servicios externos.
Esta API define los campos comunes requeridos para establecer conexiones HTTP seguras y configurables a APIs externas, incluyendo validaciones automáticas de URLs y métodos HTTP permitidos.
Información General:
| Tipo ID | Módulo | Categoría |
|---|---|---|
1 |
httplib |
api |
BaseHttpConnectionParams
Parámetros:
url: HttpUrl URL completa y válida del endpoint del servicio externo. Debe ser una URL HTTP o HTTPS válida.headers: dict[str, str], optional Diccionario de headers HTTP adicionales para incluir en la solicitud. Por defecto es None, lo que significa headers vacíos.method: ('GET', 'POST', 'PUT', 'DELETE', 'PATCH') Método HTTP a utilizar para la solicitud. Por defecto es 'GET'.body: dict, optional Cuerpo de la solicitud en formato JSON. Solo aplicable para métodos que soportan body (POST, PUT, PATCH). Por defecto es None.verify_ssl: bool Indica si se debe validar el certificado SSL del servidor. Por defecto es True para conexiones seguras.
Parámetros de entrada:
| Campo | Tipo | Requerido | Descripción | Valor por defecto | Ejemplos |
|---|---|---|---|---|---|
url |
HttpUrl | ✅ | URL completa del endpoint del servicio | PydanticUndefined |
https://api.example.com/endpoint |
headers |
Optional[dict[str, str]] | ❌ | Headers HTTP adicionales a incluir en la solicitud | None |
{"Authorization": "Bearer token", "Content-Type": "application/json"} |
method |
Literal[GET, POST, PUT, DELETE, PATCH] | ❌ | Método HTTP a utilizar | GET |
POST |
body |
Optional[dict[str, Any]] | ❌ | Cuerpo JSON de la solicitud | None |
{"key": "value"} |
verify_ssl |
bool | ❌ | Si se debe validar el certificado SSL | True |
True |
Ejemplo:
{
"url": "https://api.example.com/endpoint",
"headers": {
"Authorization": "Bearer token"
},
"method": "POST",
"body": {
"key": "value"
},
"verify_ssl": true
}
Notas:
Esta clase hereda de pydantic.BaseModel, lo que proporciona validación automática de tipos y generación de esquemas JSON. Los campos con restricciones (como url y method) lanzarán ValidationError si no cumplen con los criterios definidos.