Lector tolerante

El patrón de integración de lector tolerante permite que tu código cliente absorba los cambios en las API de Lerian (campos nuevos, reordenamientos o adiciones) sin romperse.

A medida que nuestra API pública evoluciona, los integradores y clientes necesitan adaptarse. El patrón Lector tolerante hace que un cliente sea resiliente a esos cambios.

Al adoptar el patrón Lector tolerante, las integraciones pueden manejar mejor la información nueva sin actualizaciones frecuentes. Este enfoque reduce las necesidades de mantenimiento.

​

¿Qué es un lector tolerante?

---

El patrón Lector tolerante es un enfoque de diseño de integración. En este patrón, un cliente que consume datos maneja los cambios sin problemas, como campos agregados o modificaciones menores en la estructura. Este patrón promueve la compatibilidad hacia adelante y reduce la necesidad de actualizaciones inmediatas cada vez que los datos o el servicio evolucionan.

​

Escenario del mundo real

---

Considera una solicitud a GET /organizations/{organization_id}. Al principio, la respuesta podría ser:

JSON

{
    "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
    "parentOrganizationId": null,
    "legalName": "Empresa Teste Ltda",
    "legalDocument": "86820799000188",
    "metadata": null,
    "status": {
        "code": "ACTIVE",
        "description": null
    },
    "createdAt": "2024-02-08T16:59:31+0300",
    "updatedAt": "2024-02-08T16:59:31+0300",
    "deletedAt": null
}

Más adelante, se podrían agregar campos como doingBusinessAs y address:

JSON

{
    "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
    "parentOrganizationId": null,
    "legalName": "Empresa Teste Ltda",
    "doingBusinessAs": "Empresa Teste",
    "legalDocument": "86820799000188",
    "address": {
        "line1": "Rua Botucatu, 10",
        "line2": "Casa B",
        "zipCode": "04023060",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
    },
    "metadata": null,
    "status": {
        "code": "ACTIVE",
        "description": null
    },
    "createdAt": "2024-02-08T16:59:31+0300",
    "updatedAt": "2024-02-08T16:59:31+0300",
    "deletedAt": null
}

Un cliente que sigue el patrón Lector tolerante manejaría los campos adicionales sin problemas.

​

Implementación de un lector tolerante

---

A continuación se muestra un fragmento de código Python de ejemplo que procesa los campos adicionales sin problemas.

Python

def fetch_organization_info(organization_id):
    response = requests.get(f"{host}/organization/{organization_id}")
    org_info = response.json()

    # Fetch required fields
    legal_name = org_info.get("legalName", "Unknown")
    legal_document = org_info.get("legalDocument", "No document provided")

    # Handle optional fields
    doing_business_as = org_info.get("doingBusinessAs")

    # Nested address structure
    address_info = org_info.get("address", {})
    line1 = address_info.get("line1", "Address not provided")
    city = address_info.get("city", "City not provided")
    state = address_info.get("state", "State not provided")
    country = address_info.get("country", "Country not provided")

    # Display information
    print(f"Legal Name: {legal_name}, Legal Document: {legal_document}")
    print(f"Doing Business As: {doing_business_as}")
    print(f"Address: {line1}, {city}, {state}, {country}")

# Example usage
fetch_organization_info("cc15194a-6bc9-4ebb-b15d-43411a54ba4b")

En este ejemplo, los métodos get acceden a los valores de forma segura. Esto permite flexibilidad cuando aparecen campos nuevos, como phoneNumber. El código sigue funcionando incluso si falta un campo.