Skip to main content

API's

" Veremos como trabajar con las Apis "

¿Por qué son importantes las APIs? Las APIs son fundamentales para permitir la interacción controlada entre aplicaciones, dispositivos y usuarios externos con tus servicios backend. A través de Kong, puedes gestionar y proteger estas interacciones, garantizando que solo las solicitudes autorizadas accedan a los recursos correctos. Son la clave para conectar tus servicios de manera eficiente y segura, optimizando la comunicación y el intercambio de datos con tus sistemas internos.

Esta interfaz está diseñada como el núcleo central de la gestión de APIs en la plataforma. Proporciona un espacio unificado donde los desarrolladores pueden visualizar, administrar y actualizar sus APIs de forma eficiente, asegurando una integración fluida y un rendimiento óptimo. A través de esta herramienta, se facilita el control completo sobre el ciclo de vida de las APIs, desde su configuración inicial hasta su monitoreo continuo.

D2}

La interfaz APIs muestra una lista de las APIs existentes, proporcionando información clave para una gestión y administración efectiva. Los detalles destacados incluyen:

  • Title: Nombre o identificador único de la API.
  • API Identity: Identificador interno asociado a la API.
  • Environment: Entorno en el que está configurada la API (por ejemplo, desarrollo o producción).
  • Version: Versión actual de la API.
  • Revision: Revisión específica dentro de la versión.
  • Created Date: Fecha en la que se creó la API.
  • Actions: Opciones disponibles como Show, Edit y Remove, que permiten gestionar eficientemente cada API dentro de la instancia de Kong.

Esta vista facilita la organización, edición y supervisión de las APIs, asegurando un control centralizado y efectivo de los servicios en la plataforma.

Opciones sobre los Apis:

  • Create Api

    Esta interfaz ofrece la funcionalidad de Crear, permitiendo a los usuarios añadir nuevas APIs de manera sencilla. Los usuarios pueden configurar detalles clave como el título, identidad, versión, entorno y otros parámetros esenciales para integrar y gestionar la API dentro de la instancia de Kong.

    Esta funcionalidad asegura un control eficiente sobre las nuevas APIs, facilitando su incorporación al sistema y garantizando que estén configuradas de acuerdo con los requisitos específicos del entorno.

    Al seleccionar la opción Crear APIs, se despliega el siguiente formulario, donde se debe elegir la API que se desea desplegar:

    D2

    Posteriormente, se despliega una interfaz que guía al usuario a través de una serie de pasos para revisar y configurar detalladamente la API antes de su despliegue, asegurando que cumpla con las especificaciones requeridas.

    D2

    • Paso 1: Detalles del Proxy

      En este paso, se presentan los detalles del Proxy para su revisión, incluyendo:

      • Name: Nombre del proxy.
      • Description: Descripción del proxy.
      • Targets (Existing API): Destinos asociados a la API existente.
      • Warnings: Posibles advertencias relacionadas con la configuración.

      Tal como se visualiza en la siguiente figura:

      D2

      Una vez revisada la información, se debe seleccionar el botón "Continuar" para avanzar al siguiente paso en el proceso de configuración.

    • Paso 2: OpenAPI Operations

      En este paso, se presenta una lista de las operaciones OpenAPI que serán publicadas y podrán ser consumidas posteriormente. La información incluye:

      • N°: Número de la operación.
      • Path: Ruta asociada a la operación.
      • Verb: Método HTTP (GET, POST, etc.).
      • Operation: Identificador de la operación.
      • Summary: Descripción y resumen de la operación.

      Una vez revisada la información, se debe seleccionar el botón "Continuar" para avanzar al siguiente paso en el proceso de configuración.

      Tal como se visualiza en la siguiente figura:

      D2

    • Paso 3: Transformación del OpenAPI

      En este paso, se presenta la transformación del OpenAPI hacia la configuración que Kong utilizará.

      Esto permite al usuario visualizar con claridad cómo se aplicará la definición, incluyendo, definición de servicios, rutas, métodos, entre otros.

      Esta vista proporciona una representación precisa de lo que será implementado en Kong, permitiendo validar la configuración antes de proceder.

      Tal como se visualiza en la siguiente figura:

      D2

    • Paso 4: Policies (opcional)

      En este paso, se presenta una interfaz donde el usuario tiene la opción de escribir el código correspondiente a las políticas que desee agregar. Este paso es completamente opcional y, si no se requiere añadir políticas específicas, puede dejarse en blanco.

      Una vez finalizada esta etapa, se debe seleccionar el botón "Continuar" para avanzar al siguiente paso en el proceso de configuración.

      Tal como se visualiza en la siguiente figura:

      D2

    • Paso 5: Rules (opcional)

      En este paso, se presenta una interfaz donde el usuario tiene la opción de escribir reglas de validación para la API, tales como asegurar que cumpla con estándares de seguridad como OWASP. Este paso es completamente opcional, por lo que si no se requieren reglas de validación específicas, el campo puede dejarse en blanco.

      Una vez finalizada esta etapa, se debe seleccionar el botón "Continuar" para avanzar al siguiente paso en el proceso de configuración.

      Tal como se visualiza en la siguiente figura:

      D2

    • Paso 6: Publis Api

      Este es el paso final del flujo para crear y publicar una API, donde se debe:

      1° Seleccionar el Ambiente:

      El usuario debe elegir el ambiente donde se desplegará la API desde una lista desplegable proporcionada en la interfaz. y Luego confirmar Publicación: Después de seleccionar el ambiente, se debe hacer clic en el botón "Publicar".

      Tal como se visualiza en la siguiente figura:

      D2

      2° Publicación: con la confirmación se ejecuta el despliegue donde:

      • Al presionar "Publicar", se inicia el proceso de despliegue de la API.
      • Al completarse, un mensaje de "Success" aparece en la parte superior derecha, confirmando que la publicación fue exitosa.
      • La interfaz también muestra un resumen detallado de las acciones realizadas, como elementos creados, actualizados o eliminados.

      Tal como se visualiza en la siguiente figura:

      D2

      Este último paso asegura que la API esté configurada y disponible en el ambiente seleccionado de manera efectiva.

  • Edit Api

    La opción Edit API permite modificar la configuración y detalles de una API existente en la instancia de Kong.

    Este interfaz permite actualizar y ajustar la configuración de la API según las necesidades del entorno, asegurando un control eficiente y flexible sobre sus implementaciones en la plataforma.

    Tal como se muestra en la siguiente figura:

    D2}

    Al seleccionar esta opción, se despliega un formulario con los datos actuales de la API, incluyendo información como:

    • Creation date: Fecha de creación de la API.

    • Revision selected: Revisión activa de la API.

    • Lista de estado en ambiente: Información sobre el estado de la API en diferentes entornos:

      • Environment: Entorno donde está desplegada la API.
      • Status: Estado actual de la API en el entorno:
        • Rojo: Inactivo
        • Verde: Activo
      • Actions: Opciones disponibles para gestionar la API en el entorno, tales como:
        • Deploy: Permite desplegar una versión no activa
        • Undeploy: Permite bajar una versión activa

    • Endpoints: Detalles de los endpoints definidos en la API:

      • N°: Número del endpoint.
      • Path: Ruta asociada al endpoint.
      • Verb: Método HTTP (GET, POST, etc.).
      • Operation: Operación asociada al endpoint.
      • Summary: Descripción y resumen de la operación.

      D2}

    • Declarative: Configuración declarativa actual de la API.

      D2}

    • Policies & Rules: Políticas y reglas aplicadas a la API.

      D2}

    • Show Apis

      La opción Show de API permite visualizar los detalles completos de una API seleccionada.

      Esta funcionalidad facilita la revisión y comprensión de la configuración específica de la API, proporcionando acceso a información detallada sobre su configuración y estado en la instancia de Kong.

      La información que se despliega incluye:

      • id: Identificador único de la API.
      • title: Nombre o título de la API.
      • apiIdentity: Identidad interna asociada a la API.
      • version: Versión actual de la API.
      • revision: Revisión específica de la API.
      • createdBy: Usuario que creó la API.
      • lastModifiedDate: Fecha de la última modificación realizada a la API.

      Tal como se visualiza en la siguiente figura:

      D2}

      Esto permite a los desarrolladores verificar y entender de manera clara las configuraciones asociadas, asegurando una gestión eficiente y precisa.

  • Remove Apis (Eliminar)

    La opción "Remove API" permite eliminar una API de la instancia de Kong. Al seleccionar esta opción, la API especificada, junto con su configuración y asociaciones a servicios, será eliminada, garantizando que ya no esté disponible ni sea utilizada en la plataforma.

    Cuando se elige esta opción para una API específica de la lista, se desplegará un mensaje de confirmación para asegurar que el usuario revise y valide la acción antes de proceder con la eliminación. Esto proporciona una capa adicional de seguridad en la gestión de las APIs, evitando eliminaciones accidentales.

    D2

Nota


Antes de poder eliminar una API es necesario primero realizar Undeploy de los ambientes en los cuales se encuentra desplegada y desvincular los componentes asociados.