Implementa proxies desde la línea de comandos

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

En este tema, se explica cómo implementar un proxy desde la línea de comandos. Apigee Edge ofrece dos opciones para implementar desde la línea de comandos. La primera es usar una herramienta de implementación de Apigee Edge escrita en Python. La otra es configurar y ejecutar una secuencia de comandos de shell.

Usa las técnicas de implementación de la línea de comandos cuando trabajes directamente con archivos de origen del proxy en tu sistema. Existen muchos motivos por los que podrías estar trabajando sin conexión. Es posible que desees usar tu editor XML favorito o que estés desarrollando políticas que requieran codificación Java y trabajes principalmente en un IDE. Las técnicas que se describen en esta sección te permiten subir y, también, implementar tus archivos de origen en el entorno de servicios de API que elijas.

Si trabajas principalmente en la IU de administración, consulta Implementa proxies en la IU.

Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Más información

Ejecuta la herramienta de implementación de Python para Apigee Edge

La herramienta de implementación de Python para Apigee Edge funciona con la API de administración de Edge a fin de importar e implementar proxies de API. La herramienta está disponible como parte de la distribución de los ejemplos de la plataforma de la API en GitHub. Consulta Usa los proxies de API de muestra.

Usa la herramienta Python de Apigee Edge para importar (subir) y, luego, implementar tu API en un proceso simple.

La herramienta de implementación se debe ejecutar desde el directorio base en la distribución de las muestras de la plataforma de la API, en la que el directorio base es el directorio superior de los directorios setup y tools.

En el siguiente comando, sustituye el nombre del proxy, tu nombre de usuario y contraseña de Edge, la organización y el entorno de Edge, y la ruta de acceso al directorio que contiene el directorio “apiproxy"” del proxy de la API:

python tools/deploy.py -n proxyname -u name:passW -o org -e env -d proxypath -p /

Por ejemplo:

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p /

Este comando comprime los archivos, los envía a tu organización en Apigee Edge y los implementa en el entorno especificado.

La herramienta de implementación descubre automáticamente la revisión actual del proxy de API, anula la implementación de la revisión existente y, luego, implementa una revisión incrementada del proxy de API.

Si se realiza de forma correcta, verás un resultado como el siguiente:

Writing ./<proxybasedir>/apiproxy/weatherapi.xml to apiproxy/weatherapi.xml
Writing ./<proxybasedir>/apiproxy/proxies/default.xml to apiproxy/proxies/default.xml
Writing ./<proxybasedir>/apiproxy/targets/default.xml to apiproxy/targets/default.xml
Imported new proxy version 1
Environment: test
  Revision: 1 BasePath = /
  State: deployed

De forma predeterminada, la herramienta sube el proxy de API a https://api.enterprise.apigee.com, que corresponde a Edge en la nube. También puedes usar esta herramienta para subir el proxy de API a una versión local de Edge si especificas la marca -h:

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p / -h https://192.168.11.111:8080

En este ejemplo, se especifica la dirección IP del servidor de administración perimetral. Si creaste un registro DNS para el servidor de administración, puedes especificar una URL de la siguiente forma:

https://ms_URL:8080

Esta es la lista completa de marcas para el comando:

  • -n: Es el nombre de tu proxy de API.
  • -u: El nombre de usuario y la contraseña de tu cuenta en una organización de Apigee Edge.
  • -o: Es el nombre de la organización en la que tienes una cuenta.
  • -e: Es el entorno en el que se debe implementar el proxy de API (test o prod).
  • -d: Es la ruta de acceso al directorio que contiene los archivos de proxy de la API. Tus archivos proxy de API deben almacenarse en un directorio llamado "apiproxy". Este valor es la ruta de acceso del directorio que contiene el directorio "apiproxy", y no la ruta de acceso al directorio "apiproxy" en sí.
  • -p: Es la ruta de acceso del URI que se usa como coincidencia de patrón para enrutar el mensaje entrante a esta implementación de proxy de API. En la mayoría de los casos, puedes establecer este valor en “/”, a menos que tengas requisitos avanzados de implementación y enrutamiento. La ruta principal que se usa para el enrutamiento del proxy de API se define en el archivo de configuración ProxyEndpoint del proxy de API.
  • -h: Es la URL del perímetro. De forma predeterminada, la URL es https://api.enterprise.apigee.com, que corresponde a Edge en la nube. Para una implementación local, usa la URL del servidor de administración perimetral y el puerto 8080, como en
    https://ms_URL:8080
    .

    También puedes usar la dirección IP del servidor de administración, como en https://192.168.11.111:8080.

Configura y ejecuta una secuencia de comandos de shell de implementación

El enfoque más sencillo es ejecutar la secuencia de comandos de implementación proporcionada con el proxy de API de muestra. Las secuencias de comandos de shell unen la herramienta de implementación de Python para Apigee Edge.

Desde el directorio /simplyProxy, ejecuta lo siguiente:

$ sh deploy.sh

Deberías ver lo siguiente:

Enter your password for user {myname} in the Apigee Enterprise organization {org_name}, followed by [ENTER]: 

Ingresa tu contraseña y presiona INTRO.

A continuación, deberías ver lo siguiente:

Deploying to test on https://api.enterprise.apigee.com using {myname} on enterprise.apigee.com and {org_name} on enterprise.apigee.com

Si ves lo siguiente:

Enter your password for user Your USERNAME on enterprise.apigee.com in the Apigee Enterprise organization Your ORG on enterprise.apigee.com, followed by [ENTER]: 

significa que debes modificar el archivo /setup/setenv.sh en la distribución de muestras de la plataforma. Para obtener instrucciones, consulta el archivo README o las APIs de Apigee Edge.

Cuando se realiza de forma correcta, la herramienta de implementación ZIP de los archivos en /apiproxy, importa el paquete a tu organización en Apigee Edge y, luego, implementa el proxy de la API en el entorno de “prueba”.

Tu proxy de API está listo para invocarse.