Desarrollar proxies de API

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Expone las API en Apigee Edge, debes implementar proxies de API. Los proxies de API separan la API orientada a la aplicación de sus servicios de backend, lo que protege a esas aplicaciones de los cambios en el código de backend.

Desarrolla tus proxies de API con Apigee en Cloud Code como se describe en las siguientes secciones. También consulta Administra carpetas y archivos en un lugar de trabajo de Apigee.

Crea un proxy de API

Para crear un proxy de API con Apigee en Cloud Code, asegúrate de haber creado un lugar de trabajo de desarrollo local y, luego, haz lo siguiente:

  1. Realiza una de las siguientes acciones:

    • En tu lugar de trabajo, coloca el cursor sobre la carpeta apiproxies y haz clic en Crea un ícono de proxy de API.

      + se muestra cuando posicionas el cursor sobre la carpeta de apiproxies

    • Selecciona (View > Command pal) para abrir la paleta de comandos y selecciona Cloud Code: Create Apigee proxy bundle.

    Se abrirá el asistente Crear proxy.

  2. Selecciona una de las opciones siguientes:

    Tipo Descripción
    Access token-based authentication

    Agrega una autenticación basada en OAuth 2.0 a tu proxy de API. Apigee agrega automáticamente las siguientes políticas a tu proxy de API:

    • Es la cuota para administrar la cuota en el proxy.
    • AssignMessage para quitar la clave de API, proporcionada en la llamada a la API como parámetro de consulta, de la solicitud reenviada al servidor de backend.
    • OAuthV2 como método de autenticación
    API key-based authentication

    Un proxy de API que usa una verificación de clave de API simple. Apigee agrega automáticamente las siguientes políticas a tu proxy de API:

    • Es la cuota para administrar la cuota en el proxy.
    • VerifyAPIKey para validar claves de API presentadas mediante la solicitud de apps.
    • AssignMessage para quitar la clave de API, proporcionada en la llamada a la API como parámetro de consulta, de la solicitud reenviada al servidor de backend.
    Echo request

    Un proxy de API que repite las solicitudes. No hay un backend de destino o de API para este tipo de proxy ni autenticación. No se te solicita que especifiques una URL para el servicio de backend (Target (Existing API)) y no se incluye la configuración del extremo de destino predeterminado.

    Simple reverse proxy

    Un proxy de API que pasa solicitudes a un destino de backend. No incluye la autenticación, por lo que las solicitudes se pasan al backend sin ninguna verificación de seguridad.
    OpenAPI 3.0 spec

    Para crear un proxy, carga una especificación OpenAPI 3.0 existente. Para obtener más información, consulta OpenAPI Initiative.

  3. Consulta Campos principales del proxy de API para obtener información sobre los campos, como la ruta base, necesarios para crear cada tipo de proxy. Responde cada una de las indicaciones y presiona Intro para confirmar y continuar, o Esc para cancelar el asistente.

Después de completar los pasos del asistente, se agrega la carpeta apiproxy-name nueva en apiproxies en la sección Apigee. Cada carpeta de proxy de API se estructura como se describe en la estructura del directorio de configuración del proxy de API.

A continuación, se proporciona un ejemplo de la configuración predeterminada creada para un proxy de API creado con el tipo API key-based authentication.

Estructura de carpetas de un proxy de autenticación basado en una clave de API

Para obtener una descripción de la configuración predeterminada, consulta Explora la configuración predeterminada del proxy de API.

Explora la configuración predeterminada del proxy de API

En la siguiente tabla, se resumen los contenidos incluidos en la configuración predeterminada cuando creas un proxy de API según el tipo de proxy de API y las opciones de autenticación seleccionadas.

Archivo de configuración
Proxy inverso simple
Solicitud de eco
Autenticación de tokens de acceso (OAuthV2)
Autenticación de la clave de API
proxies/default.xml
Configuración predeterminada del extremo de proxy.
targets/default.xml
Configuración predeterminada del extremo de destino.
 
impose-quota.xml
Política de cuotas para definir una cuota predeterminada.		    
remove-header-authorization.xml
Política AssignMessage a fin de quitar el encabezado Authorization que se pasa para la autenticación.		    
 
remove-query-param-apikey.xml
Política AssignMessage a fin de quitar el parámetro de búsqueda apikey que se pasa para la autenticación		      
verify-api-key.xml
Política VerifyAPIKey para aplicar la verificación de las claves de API.		      
La política verify-oauth-v2-access-token.xml de
OAuthV2 para validar los tokens de acceso de OAuth V2.		    
 

Sube un paquete de proxy de API

Para subir un paquete de proxy de API a Apigee en Cloud Code, haz lo siguiente:

  1. Realiza una de las siguientes acciones:

    • En tu espacio de trabajo de Apigee, coloca el cursor sobre la carpeta apiproxies y haz clic en Ícono para importar un paquete de proxy de API.

    • Selecciona (View > Command pal) para abrir la paleta de comandos y selecciona Cloud Code: Import Apigee proxy package.

  2. Navega hasta el paquete del proxy de API que deseas subir y haz clic en Seleccionar. El paquete del proxy de API debe estructurarse como se describe en Estructura del directorio de configuración del proxy de API.

  3. De forma predeterminada, el nombre del archivo ZIP menos su extensión se usa para el nombre del proxy de API (opcional). Si este nombre no es único, se te pedirá que ingreses un nombre único.

La carpeta apiproxy-name que se subió se agrega en apiproxies en tu espacio de trabajo.

Administra extremos de proxy

Como se describe en ¿Qué es un proxy de API?, un extremo de proxy (ProxyEndpoint) define la forma en que las apps cliente consumen tus API. Configura el extremo de proxy para definir la URL de tu proxy de API. El extremo del proxy también determina si las apps acceden al proxy de API a través de HTTP o HTTPS. Puedes adjuntar políticas al extremo del proxy para aplicar seguridad, verificaciones de cuotas y otros tipos de control de acceso y límite de frecuencia.

Crea y configura extremos de proxy como se describe en las siguientes secciones.

Crea extremos de proxy

Cuando creas un proxy de API, se agrega un extremo de proxy predeterminado a la configuración del proxy de API. Para obtener más información, consulta Explora la configuración predeterminada del proxy de API. Puedes crear extremos de proxy adicionales, según sea necesario.

Para crear un extremo de proxy con Apigee en Cloud Code, haz lo siguiente:

  1. En tu espacio de trabajo de Apigee, realiza una de las siguientes acciones:

    • Coloca el cursor sobre una de las siguientes carpetas, haz clic en Crea el ícono de extremo de proxy y selecciona Crear extremo de proxy:
      • Paquete del proxy apiproxy-name
      • apiproxy-name/apiproxy
    • Coloca el cursor sobre la carpeta apiproxy-name/apiproxy/proxies y haz clic en Crea el ícono de extremo de proxy.

    Se abrirá el asistente Crear extremo de proxy.

  2. Ingresa los valores del siguiente conjunto de mensajes. Presiona Intro después de cada una a fin de confirmar y continuar o Esc para cancelar.

    Campo Descripción
    Proxy endpoint name Nombre que se usa para identificar el extremo del proxy.
    API proxy base path Parte de la URL usada para realizar solicitudes a tu API. Apigee usa la URL para hacer coincidir solicitudes entrantes y enrutarlas al proxy de API adecuado.
    Target endpoint Selecciona no target o default. Consulta Elementos de configuración de ProxyEndpoint para obtener información.

El extremo se crea y se agrega a la carpeta apiproxy-name/apiproxy/proxies en la sección Apigee y se abre en el editor. Configura el extremo del proxy, como se describe en la siguiente sección.

Configura extremos de proxy

Para configurar los extremos del proxy, consulta las siguientes secciones:

Administra extremos de destino

Como se describe en ¿Qué es un proxy de API?, un extremo de destino (TargetEndpoint) define la forma en que el proxy de API interactúa con tus servicios de backend. Puedes configurar el extremo de destino para reenviar solicitudes al servicio de backend adecuado y definir la configuración de seguridad, el protocolo HTTP o HTTPS, y otra información de conexión. Puedes adjuntar políticas al extremo de destino a fin de asegurarte de que los mensajes de respuesta tengan el formato correcto para la app que realizó la solicitud inicial.

Crea y configura extremos de destino como se describe en esta sección.

Crea extremos de destino

Cuando creas un proxy de API inverso, se agrega un extremo de destino predeterminado a la configuración del proxy de API. Cuando creas un proxy de API sin destino de backend, solo se agrega el extremo del proxy predeterminado a la configuración del proxy de API, no se agrega ningún extremo de destino. Para obtener más información, consulta Explora la configuración predeterminada del proxy de API.

Crea extremos de destino, según sea necesario.

Para crear un extremo de destino con Apigee en Cloud Code, haz lo siguiente:

  1. En tu espacio de trabajo de Apigee, realiza una de las siguientes acciones:

    • Coloca el cursor sobre una de las siguientes carpetas, haz clic en Crea un ícono de extremo de destino y selecciona Crear extremo de destino:
      • Paquete del proxy apiproxy-name
      • apiproxy-name/apiproxy
    • Coloca el cursor sobre la carpeta apiproxy-name/apiproxy/targets y haz clic en Crea un ícono de extremo de destino.

    Se abrirá el asistente Crear extremo de destino.

  2. Realiza los siguientes pasos en función del tipo de extremo de destino que desees crear:

    Tipo Pasos
    Destino de HTTP(S) externo

    Para definir un destino HTTP(S) externo, haz lo siguiente:

    1. Selecciona Destino HTTP(S).
    2. Ingresa el nombre del extremo de destino en Nombre del extremo de destino.
    3. Ingresa la URL del servicio de backend que invoca este extremo de destino en URL de destino del backend.

    Para obtener más información, consulta Determina la URL del extremo de destino.
    Encadenamiento de proxy

    Para definir un proxy de API implementado de forma local como destino, haz lo siguiente:

    1. Selecciona Encadenamiento de proxy.
    2. Ingresa el nombre del extremo de destino en Nombre del extremo de destino.
    3. Selecciona un proxy de API.
    4. Selecciona el extremo del proxy.

    Para obtener más información, consulta Encadena los proxies de API.

    Destino del balanceo de cargas

    Para definir un destino de balanceo de cargas con los servidores de destino definidos en el entorno, haz lo siguiente:

    1. Selecciona Destino del balanceo de cargas.
    2. Ingresa el nombre del extremo de destino en Nombre del extremo de destino.

    Para obtener más información, consulta Configura un TargetEndpoint para balancear cargas entre TargetServers con nombre.

El extremo de destino se crea y se agrega a la carpeta apiproxy-name/apiproxy/targets y se abre en el editor. Configura el extremo de destino, como se describe en la siguiente sección.

Configura extremos de destino

Configura los extremos de destino, como se describe en los siguientes temas.