Creación de un proxy de API,Creación de un proxy de API

Esta página se aplica a Apigee y Apigee híbrido .

Ver la documentación de Apigee Edge .

Cree un proxy en la interfaz de usuario de Apigee o usando la API, como se describe en las siguientes secciones.

Campos principales del proxy API

Siga estas pautas al crear un proxy API:

Campo Descripción
Nombre del proxy de API Nombre mostrado para tu API. Especifica caracteres alfanuméricos, guion (-) o guion bajo (_).
Ruta base del proxy API Fragmento de URI que aparece después de la dirección http://[host] o https://[host] de tu proxy de API. Apigee utiliza el URI de la ruta base para conectar y enrutar las solicitudes entrantes al proxy de API correspondiente.

Utilice comodines en las rutas base

Use uno o más comodines en las rutas base de los proxys de API para asegurar su futuro. Permitimos la especificación de un solo comodín * entre dos barras diagonales / : /*/ . Por ejemplo, una ruta base de /team/*/members permite a los clientes llamar https://[host]/team/blue/members y https://[host]/team/green/members sin necesidad de crear nuevos proxies de API para dar soporte a nuevos equipos. Puede reemplazar cualquier número de tokens en la ruta base siguiendo este patrón. Otros patrones, como /** , /something* o /*something , no son compatibles.

Descripción (Opcional) Una descripción para el proxy API.
URL de destino/objetivo de backend URL (incluido HTTP o HTTPS) del servicio backend que este proxy API invoca.
Espacio (Opcional) Si su organización tiene Apigee Spaces habilitado, puede asociar el proxy de API con un espacio. Para obtener más información, consulte la descripción general de Apigee Spaces .

Pasos para crear un proxy API

Para crear un proxy de API utilizando la interfaz de usuario o las API:

Consola de Apigee en la nube

Para crear un proxy en la consola de Apigee en la nube:

  1. Abra la interfaz de usuario de Apigee en la consola Cloud en un navegador.
  2. En el panel de navegación izquierdo, haga clic en Desarrollo de proxy > Proxies de API .
  3. En el panel Proxies de API , haga clic en + Crear .
  4. En el panel Crear un proxy , en Plantilla de proxy , seleccione Proxy inverso (más común) .
  5. En Detalles del proxy , ingrese lo siguiente:
    • Nombre del proxy: ingrese un nombre para el proxy, como myproxy .
    • Ruta base : Se establece automáticamente con el valor que introduzca en Proxy name . La ruta base forma parte de la URL que se utiliza para realizar solicitudes a su API. Apigee utiliza la URL para conectar y enrutar las solicitudes entrantes al proxy de API correspondiente.
    • Descripción (opcional) : ingrese una descripción para su nuevo proxy API, como "Probar Apigee con un proxy simple".
    • Destino (API existente): Introduzca https://mocktarget.apigee.net . Esto define la URL de destino que Apigee invoca en una solicitud al proxy de la API. El servicio mocktarget se aloja en Apigee y devuelve datos simples. No requiere clave de API ni token de acceso.
    • Espacio (opcional) : Si su organización tiene habilitados Apigee Spaces, puede asociar el proxy de API con un espacio seleccionado de la lista de opciones disponibles. Para obtener más información, consulte la descripción general de Apigee Spaces .
    • Haga clic en Siguiente .
  6. Implementar (opcional) :
    • Entornos de implementación : Opcional. Utilice las casillas de verificación para seleccionar uno o más entornos donde implementar el proxy. Si prefiere no implementar el proxy en este momento, deje el campo "Entornos de implementación" vacío. Siempre puede implementar el proxy más adelante.
    • Cuenta de servicio : Opcional. Adjunte una cuenta de servicio a su implementación para que su proxy pueda acceder. Google Cloud servicios, como se especifica en el rol y los permisos de la cuenta de servicio.
  7. Haga clic en Crear .

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

Panel de resumen de myproxy.

Si decide implementar el proxy, la sección "Implementaciones" muestra el número de revisión , que es 1 al momento de la primera implementación. La columna "Estado" muestra los entornos donde se implementa el proxy con un indicador de estado verde.

Apigee clásico

Para crear un proxy API simple en la interfaz de usuario clásica de Apigee:

  1. Inicie sesión en la interfaz de usuario de Apigee .
  2. Haga clic en Proxies API en la vista principal.
  3. En la lista desplegable Entorno , seleccione el entorno en el que desea crear un nuevo proxy API.

    La interfaz híbrida muestra una lista de proxies de API para ese entorno. Si aún no ha creado ningún proxie, la lista estará vacía.

  4. Haga clic en Crear nuevo .

    Se iniciará el asistente para crear proxy.

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

    Un proxy inverso

    Se muestra la página de detalles del proxy .

  6. Configure su proxy con las siguientes configuraciones:
    • Nombre: Introduce getstarted . Si ya existe un proxy con este nombre, elige uno diferente.
    • Ruta base: Establezca esta opción en /getstarted . La ruta base forma parte de la URL utilizada para realizar solicitudes a su API. Apigee utiliza la URL para conectar y enrutar las solicitudes entrantes al proxy de API correspondiente.
    • Descripción (opcional): ingrese una descripción para su nuevo proxy API, como Get started API proxy .
    • Destino (API existente): Introduzca https://mocktarget.apigee.net . Esto define la URL de destino que Apigee invoca en una solicitud al proxy de la API. El servicio mocktarget se aloja en Apigee y devuelve datos simples. No requiere clave de API ni token de acceso.

    Los detalles de su proxy API deberían verse así:

    Detalles del proxy API

  7. Haga clic en Siguiente .
  8. En la vista Políticas comunes , en Seguridad: Autorización, seleccione Pasar a través (sin autorización) .

    Selección de paso

  9. Haga clic en Siguiente .
  10. En la página Resumen , seleccione los entornos de implementación, si lo desea, y haga clic en Crear e implementar .

    Crear e implementar

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

    Pantalla de implementación exitosa

  11. Haga clic en Editar proxy para mostrar la pestaña Descripción general en el Editor de proxy.
  12. Editar lista de proxy

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

Muestra la lista de servidores proxy de API. El estado de implementación inicial es verde.

API de Apigee

Cree un proxy de API en su organización Apigee emitiendo una solicitud POST al siguiente recurso:

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

Debe definir el nombre del proxy de API mediante el parámetro de consulta name . Limite los caracteres del nombre a los siguientes: A-Za-z0-9._\-$ %

Opcionalmente, puede importar un paquete de configuración de proxy de API realizando los siguientes pasos:

  • Establezca el parámetro de consulta action para import
  • Establezca el encabezado Content-type en multipart/form-data
  • Pase el nombre del paquete de configuración del proxy API en su sistema de archivos local

El siguiente ejemplo demuestra cómo crear un proxy de API importando un paquete de configuración de proxy de API ( helloworld-config.zip ) en su 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 "[email protected]"

Donde $TOKEN se establece en su token de acceso de OAuth 2.0, como se describe en "Obtención de un token de acceso de OAuth 2.0" . Para obtener información sobre las opciones curl utilizadas en este ejemplo, consulte "Uso de curl" . Para obtener una descripción de las variables de entorno utilizadas, consulte "Configuración de variables de entorno para solicitudes de 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 la creación de un proxy de API, consulte el método apis.create en la API de Apigee. Para ver todos los métodos disponibles para los proxies de API, consulte la API de proxies de API .

Próximos pasos

Después de crear un proxy de API simple, normalmente realiza una de las siguientes acciones: