Usa los proxies de API de muestra

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Requisitos previos

Necesitarás una cuenta en http://enterprise.apigee.com. Puedes registrarte para obtener una cuenta de prueba en http://accounts.apigee.com/accounts/sign_up.

Para usar las muestras, también debes tener lo siguiente:

Herramienta Descripción
Git Las muestras se encuentran en GitHub. Si no tienes instalado Git, consulta las instrucciones de configuración de Git de GitHub . Si no quieres instalar Git, puedes explorar los archivos y descargar un archivo ZIP desde https://github.com/apigee/api-platform-samples.
Python

Se requiere Python para ejecutar la herramienta de implementación de Apigee. Python está presente en la mayoría de los entornos de Linux , en una Mac con XCode instalado, en una máquina con Windows con Cygwin instalado y en muchos otros lugares.

Para obtener Python, consulta la página de descargas de Python.
curl Las secuencias de comandos de configuración de muestra también usan curl. Asegúrate de que curl esté instalado y disponible en tu ruta de acceso (ejecuta el comando which curl para ver si está disponible en tu sistema).
dos2unix Si ejecutas Cygwin en Windows, es posible que también necesites la dos2unix utilidad. (El instalador de Cygwin te permite instalar la utilidad).

Descarga las muestras

Para obtener los archivos de muestra, usa git clone, como se muestra en el siguiente ejemplo:

git clone https://github.com/apigee/api-platform-samples.git

Importa e implementa los proxies de API de muestra

Importa e implementa las muestras desde la línea de comandos:

  1. Después de descargar las muestras, ve al directorio /setup, como se muestra en el siguiente ejemplo: 
    cd setup
  2. En el directorio /setup, busca el archivo setenv.sh.
  3. Edita este archivo para configurar tu organización, la dirección de correo electrónico asociada con tu nombre de usuario, y el entorno (prod o test) en el que deseas implementar los proxies de API.
  4. Después de editar setenv.sh, ejecuta lo siguiente: 
    sh deploy_all.sh

    Esta secuencia de comandos implementa todas las muestras de proxy de API en tu organización. (El proceso tarda entre 3 y 4 minutos). Sigue las indicaciones para implementar productos de API, desarrolladores y apps (que se usan para OAuth).

  5. Una vez que se complete la secuencia de comandos de implementación, navega al directorio sample-proxies. En el directorio sample-proxies, encontrarás un directorio por cada proxy de muestra. En cada directorio, hay un archivo README.md con información sobre la ejecución de la muestra y dos secuencias de comandos que te ayudan a realizar pequeños cambios en las muestras, implementarlas y, luego, invocar la muestra para ver qué efecto tuvo el cambio:
    • invoke.sh: Ejecuta esta secuencia de comandos para invocar la versión implementada del proxy de API.
    • deploy.sh: Ejecuta esta secuencia de comandos para implementar el proxy de API después de realizar cualquier cambio.

Invoca los proxies de API de muestra

Cada proxy de muestra tiene una secuencia de comandos de shell asociada que se puede usar para invocar el proxy de API después de implementarlo.

Desde el directorio /sample-proxies/proxy_name, ejecuta lo siguiente:

sh invoke.sh

Esto invoca el proxy que se ejecuta en el entorno de pruebas de tu organización.

Solución de problemas

Para obtener información sobre la solución de problemas, consulta lo siguiente:

Modifica y vuelve a usar los proxies de API de muestra

El uso típico de los proxies de muestra es modificar, implementar e invocar. Esto te permite realizar pequeñas modificaciones y, luego, ver qué efecto tienen en el mensaje de respuesta.

Para modificar un proxy de API de muestra para que apunte a un servicio de backend diferente, modifica el archivo de configuración XML en la siguiente ubicación:

/apiproxy/targets/target_name.xml

Por ejemplo, para que la muestra de clave de API apunte a tu propio servicio de backend, busca este archivo:

/apikey/apiproxy/targets/default.xml

Si la configuración predeterminada apunta a http://mocktarget.apigee.net, como en el siguiente ejemplo:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

y tu servicio de backend está disponible en http://api.myproject.com/, modifica la configuración para que se vea de la siguiente manera:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Después de guardar los cambios, implementa el proxy de API como se muestra en el siguiente ejemplo:

sh deploy.sh

Los otros proxies de API se pueden modificar de la misma manera para usar la funcionalidad del proxy de API en tus servicios de destino existentes. Sin embargo, en algunos casos, el comportamiento del proxy de API depende de formatos de mensajes específicos, por lo que es posible que los proxies necesiten cambios de configuración adicionales.