Gravitee Api Manager

Introducción

Inicio rápido

Gravitee API Manager consta de dos componentes principales para desarrolladores:

1. Consola de administración proporciona una interfaz web para administrar y configurar las APIs.
2. Portal para desarrolladores proporciona una interfaz para que los desarrolladores registren, documenten, prueben y monitoreen las APIs.

Ambos componentes trabajan juntos para ofrecer una experiencia completa y fácil de usar para desarrolladores y administradores de APIs.

Arquitectura general

Console UI:

Es una interfaz web que permite a los administradores configurar y gestionar la plataforma de manera sencilla.

Los desarrolladores pueden realizar varias actividades en la consola de usuario (UI) de Gravitee API Manager, algunas de las principales incluyen:

• Crear y gestionar APIs: Los desarrolladores pueden crear nuevas APIs y configurar sus detalles, como la autenticación, autorización y políticas de seguridad. También pueden editar y eliminar APIs existentes.
• Manejo de usuarios y roles: Los desarrolladores pueden crear y gestionar usuarios y roles, asignando diferentes permisos para acceder y utilizar las APIs.
• Monitoreo y análisis: La consola de usuario proporciona herramientas para monitorear el rendimiento de las APIs, como estadísticas de tráfico y errores, y herramientas para analizar el uso de las APIs.
• Documentación y soporte: Los desarrolladores pueden crear y publicar documentación para las APIs, incluyendo ejemplos de código y detalles de las solicitudes y respuestas. También pueden proporcionar soporte para los usuarios de las APIs.
• Gestión de versión: Los desarrolladores pueden manejar versiones de sus API, ya sea cambiando o creando nueva versiones, y asignando diferentes políticas de seguridad.

Alta de API

1. El registro de un API en Gravitee API Manager se hace a través del menú principal en la izquierda. En la sección de APIs, haga clic en el botón ‘+Agregar API’.

   

2. El asistente de creación de API nos guía a través de varios pasos. Se recomienda seguir las mejores prácticas para REST, disponibles en la guía mejores prácticas.

   2.1 Se selecciona “Continue in the wizard” 2.2 Se especifica el nombre, la versión conforme al versionado semántico, una descripción, y un contexto único por cada servicio.
   2.3 Se crea el primer plan con: el nombre del plan, el tipo de seguridad, la descripción del plan, y los recursos que debe involucrar.
   2.4 En caso de contar con el diseño en OpenAPI se puede cargar en este paso, en caso contrario se da click sobre “skip”.
   2.5 Se finaliza el asistente creando e iniciando la api.
   

3. Consola de administración general de API

Portal de desarrolladores:

Es una interfaz web que permite a los desarrolladores registrar sus aplicaciones y solicitar claves de API.

• Los desarrolladores pueden realizar varias actividades en el portal para desarrolladores de Gravitee API Manager, algunas de las principales incluyen:
• Registro y obtención de claves de acceso: Los desarrolladores pueden registrarse en el portal y solicitar claves de acceso para utilizar las APIs.
• Documentación y soporte: El portal proporciona documentación detallada y ejemplos de código para ayudar a los desarrolladores a utilizar las APIs. También proporciona una sección de soporte para que los desarrolladores puedan hacer preguntas y obtener ayuda.
• Pruebas de APIs: El portal permite a los desarrolladores probar las APIs antes de implementarlas en sus aplicaciones, ya sea a través de una consola interactiva o mediante una herramienta de prueba automatizada.
• Monitoreo y análisis: Los desarrolladores pueden monitorear el rendimiento de las APIs y analizar su uso, mediante las estadísticas y gráficos proporcionados en el portal.
• Analítica de datos: El portal proporciona analítica de datos de las APIs, para ayudar a los desarrolladores a entender como los usuarios utilizan las APIs y para mejorar la experiencia de usuario.
• Gestión de versión: Los desarrolladores pueden obtener acceso a diferentes versiones de las APIs y también pueden verificar cambios en las versiones.

Alta de aplicación

En Gravitee API Manager, una API se compone de varios elementos básicos, algunos de los cuales incluyen:

1. Endpoints: Un endpoint es un punto de acceso de una API que se utiliza para recibir y responder a las solicitudes de los clientes.
2. Plan de precios: Un plan de precios es un conjunto de reglas que especifican el número de solicitudes permitidas, el ancho de banda, el almacenamiento y otros límites de uso.
3. Autenticación y autorización: Una API puede requerir autenticación y autorización para garantizar que solo los usuarios autorizados puedan acceder a ella.
4. Documentación: Una API debe proporcionar documentación detallada sobre cómo usarla, incluyendo ejemplos de código y descripciones de los parámetros de entrada y salida.

Api Gateway:

Es el componente principal de Gravitee que se encarga de recibir las solicitudes de las API y de aplicar las políticas de seguridad y autenticación configuradas.

Management API:

Es una API que permite a gravitee gestionar y configurar la plataforma.

Ligas de referencia

• Documentación oficial: https://docs.gravitee.io/apim/3.x/apim_overview_introduction.html

Procedimiento de solicitud de modificación de API-Manager

1. El usuario genera el ticket en OTRS utilizando el siguiente formato: [05.RFC - Modificación de componentes de infraestructura (modificación a los componentes ya instalados).]


2. El equipo de Infraestructura Analizará la información proporcionada y:
   1. Solicita al remitente la información faltante
   2. o
   3. Solicita el VoBo o Autorización del jefe inmediato o de algún superior facultado.


3. El usuario responde:
   1. Con la información restante reiniciando en el punto 2
   2. o
   3. Adjunta evidencia de VoBo o autorización que impida el repudio posterior del jefe inmediato o algún superior facultado


4. El equipo de infraestructura atiende enviando evidencia de la ejecución.


5. El usuario valida la correcta ejecución o contesta indicando el error.