Crea un proxy de API

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

Consulta la documentación de Apigee Edge.

Nota: En los entornos habilitados para implementaciones de archivos, no puedes desarrollar proxies de API mediante la IU de Apigee, la API o gcloud. Si deseas desarrollar proxies de API para implementaciones de archivos mediante Apigee en VS Code, consulta Desarrolla proxies de API mediante Apigee en VS Code.

Crea un proxy en la IU de Apigee o mediante la API, como se describe en las siguientes secciones.

Campos principales del proxy de API

Sigue estos lineamientos cuando crees un proxy de API:

Campo	Descripción
Nombre del proxy de API	Es el nombre que se muestra para tu API. Especifica caracteres alfanuméricos, guiones (-) o guiones bajos (_). Nota: El nombre del proxy de API no debe coincidir con el nombre de ningún proxy de API en la organización que se pueda implementar enEntorno con implementación de proxy habilitada.
Ruta de acceso base del proxy de API	Fragmento de URI que aparece después de la dirección http://[host] o https://[host] del tu proxy de API. Apigee usa el URI de la ruta base para hacer coincidir los mensajes de solicitud entrantes y enrutarlos al proxy de API adecuado. Nota: La ruta base debe ser única. No puedes implementar dos proxies de API con la misma ruta base. Si editas un proxy de API implementado y configuras la ruta base con el mismo valor que la ruta base de otro proxy de API, Apigee anulará automáticamente la implementación de este proxy cuando lo guardes. Antes de poder volver a implementar el proxy de API, debes editar la ruta base para que sea única. Use comodines en las rutas base Usa uno o más comodines en las rutas base del proxy de API para preparar a los proxies de API para el futuro. Permitimos la especificación de un solo carácter comodín * entre dos caracteres de barra diagonal /: /*/. Por ejemplo, una ruta base de /team/*/members permite que los clientes llamen a https://[host]/team/blue/members y a https://[host]/team/green/members sin necesidad de crear proxies de API nuevos para admitir equipos nuevos. Puedes reemplazar cualquier cantidad de tokens en la ruta de acceso base siguiendo este patrón. No se admiten otros patrones, como /**, /something* o /*something.
Descripción	(Opcional). Es una descripción del proxy de API.
URL de destino o de backend	Es la URL (incluidos HTTP o HTTPS) del servicio de backend que invoca este proxy de API.

Pasos para crear un proxy de API

Para crear un proxy de API con la IU o las APIs, haz lo siguiente:

Apigee en la consola de Cloud

Para crear un proxy simple en Apigee en la consola de Cloud, haz lo siguiente:

1. Abre la IU de Apigee en la consola de Cloud en un navegador.
   Nota: Si ves la página Te damos la bienvenida a la administración de API de Apigee, debes proporcionar tu organización de Apigee. antes de continuar.

   Después de aprovisionar Apigee, cierra la IU y vuelve a abrir la IU de Apigee en la consola de Cloud.

2. En el panel de navegación izquierdo, haz clic en Desarrollo de proxy > Proxies de API.
3. En el panel Proxies de API, haz clic en + Crear.
4. En el panel Crear un proxy, en Plantilla de proxy, selecciona Proxy inverso (más común).
5. En Detalles del proxy, ingresa lo siguiente:
   • Nombre del proxy: Ingresa un nombre para el proxy, como myproxy.
   • Ruta base: Se establece de forma automática en el valor que ingresas para Proxy name. La ruta base es parte de la URL que se usa para realizar solicitudes a la API. Edge usa la URL para hacer coincidir solicitudes entrantes y enrutarlas al proxy de API adecuado.
   • Descripción (Opcional): Ingresa una descripción para tu nuevo proxy de API, como "Prueba de Apigee con un proxy simple".
   • Destino (API existente): Ingresa https://mocktarget.apigee.net. Esto define la URL de destino que Apigee invoca en una solicitud al proxy de API. El servicio de destino ficticio se aloja en Apigee y muestra datos simples. No requiere una clave de API ni un token de acceso.
   • Haz clic en Siguiente.
6. Implementa (opcional):
   • Entornos de implementación: Opcional. Usa las casillas de verificación a fin de seleccionar uno o más entornos para implementar tu proxy. Si prefieres no implementar el proxy en este punto, deja vacío el campo Entornos de implementación. Siempre puedes implementar el proxy más adelante.
   • Cuenta de servicio: (opcional) Conecta una cuenta de servicio a tu implementación para permitir que tu proxy acceda a los servicios de Google Cloud, como se especifica en la función y los permisos de la cuenta de servicio.
7. Haz clic en Crear.

Apigee crea el nuevo proxy y muestra un resumen de los detalles del proxy en la vista Resumen del proxy.

Si eliges implementar el proxy, con la sección Implementaciones puedes ver el número de Revisión, que es 1 cuando se implementa por primera vez. En la columna Estado, se muestran los entornos en los que se implementa el proxy con un indicador de estado verde.

Apigee clásico

Para crear un proxy de API simple en la IU clásica de Apigee, haz lo siguiente:

1. Accede a la IU de Apigee.
2. Haz clic en Proxies de API en la vista principal.
3. En la lista desplegable Entorno, selecciona el entorno en el que deseas crear un proxy de API nuevo.

   En la IU híbrida, se muestra una lista de los proxies de API para ese entorno. Si aún no has creado ningún proxy, la lista estará vacía.

4. Haz clic en Crear nuevo.

   Se inicia el asistente de creación de proxy.

5. Haz clic en Proxy inverso (más común).

   

   Se muestra la página Detalles del proxy.

6. Configura tu proxy con los siguientes ajustes:
   • Nombre: Ingresa getstarted. Si ya existe un proxy con este nombre, elige uno diferente.
   • Ruta base: Configura este parámetro como /getstarted. La ruta base es parte de la URL que se usa para realizar solicitudes a la API. Edge usa la URL para hacer coincidir solicitudes entrantes y enrutarlas al proxy de API adecuado.
   • Descripción (opcional): Ingresa una descripción para el nuevo proxy de API, como Get started API proxy.
   • Destino (API existente): Ingresa https://mocktarget.apigee.net. Esto define la URL de destino que Apigee invoca en una solicitud al proxy de API. El servicio de destino ficticio se aloja en Apigee y muestra datos simples. No requiere una clave de API ni un token de acceso.

   Los detalles de tu proxy de API deben tener el siguiente aspecto:

   

7. Haz clic en Siguiente.
8. En la vista Políticas comunes, en Seguridad: autorización, selecciona Pasar (sin autorización).

   

9. Haz clic en Siguiente.
10. En la página Resumen, selecciona los entornos de implementación, si lo deseas, y haz clic en Crea e implementa.

    

    Nota: Si no seleccionas un entorno en Implementación opcional, el botón en la parte inferior derecha estará etiquetado como Crear
    Nota: Después de implementar una revisión del proxy de API, no puedes editarla. Para editar el proxy de API, debes crear y, luego, implementar una revisión nueva.

    Por este motivo, puedes optar por crear el proxy de API sin implementarlo en ningún entorno. Puedes editar el proxy de API y, luego, implementarlo más adelante, como se describe en Próximos pasos.

    Tu proxy de API nuevo se crea y se implementa en el entorno seleccionado.

    

11. Haz clic en Editar proxy para mostrar la pestaña Descripción general en el Editor de proxies.

En la lista de proxies de API, el estado de implementación del proxy de API getstarted es verde para el entorno test.

API de Apigee

Crea un proxy de API en tu organización de Apigee mediante el envío de una solicitud POST al siguiente recurso:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

Debes definir el nombre del proxy de API mediante el parámetro de búsqueda name. Restringe los caracteres que se usan en el nombre a lo siguiente: A-Za-z0-9._\-$ %

De manera opcional, puedes importar un paquete de configuración de proxy de API mediante los siguientes pasos:

• Establece el parámetro de consulta action en import.
• Configura el encabezado Content-type como multipart/form-data.
• Pasa el nombre del paquete de configuración del proxy de API a tu sistema de archivos local.

En el siguiente ejemplo, se muestra cómo crear un proxy de API mediante la importación de un paquete de configuración de proxy de API (helloworld-config.zip) en tu sistema de archivos local mediante la API.

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Si deseas obtener una descripción de las variables de entorno que se usaron, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta:

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

Para obtener más información sobre cómo crear un proxy de API, consulta el método apis.create en la API de Apigee. Si deseas ver todos los métodos disponibles para los proxies de API, consulta la API de proxies de API.

Próximos pasos

Después de crear un proxy de API simple, por lo general, se realiza una de las siguientes acciones:

• Agrega políticas, seguridad y otras funciones de la plataforma de Apigee, como se describe en Comprende las API y los proxies de API.
• Impleméntalo en tu clúster, como se describe en Implementa un proxy de API.