Usa los proxies de API de muestra

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X.
información

Requisitos previos

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

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

Herramienta Descripción
Git Las muestras se encuentran en GitHub. Si no tienes Git instalado, consulta Instrucciones de configuración de Git en GitHub. Si no desea instalar Git, puede explorar los archivos y descargar un 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 sistemas de Linux en una Mac con Xcode instalado, en una máquina con Windows que tenga Cygwin instalado y en muchos otros lugares.

Para obtener Python, consulta la Página de descarga 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 el dos2unix o de terceros. (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 la API de muestra proxies

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, ubica el archivo setenv.sh.
  3. Edita este archivo para establecer tu organización, la dirección de correo electrónico asociada a tu nombre de usuario, y el entorno (de producción o de prueba) en el que quieres implementar los proxies de la API.
  4. Después de editar setenv.sh, ejecuta lo siguiente:
    sh deploy_all.sh

    Con esta secuencia de comandos, se implementan todos los ejemplos del proxy de API en tu organización. (El proceso demora entre 3 y 4 minutes.) 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 la sample-proxies, encontrarás un directorio por proxy de muestra. En cada es un archivo README.md con información sobre cómo ejecutar la muestra y dos secuencias de comandos ayudarte a realizar cambios pequeños en las muestras, implementarlas y, luego, invocarlas para ver qué efecto tuvo el cambio:
    • invoke.sh: Ejecuta esta secuencia de comandos para invocar la versión implementada de la API. proxy.
    • deploy.sh: Ejecuta esta secuencia de comandos para implementar el proxy de API después de realizar cualquiera cambios.

Invocar 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 implementarla.

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

sh invoke.sh

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

Soluciona problemas

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

Modifica y reutiliza los proxies de API de muestra

El uso típico de los proxies de muestra es la modificación, la implementación y la invocación. Esto te permite hacer pequeñas modificaciones y, luego, ver qué efecto tienen en el mensaje de respuesta.

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

/apiproxy/targets/target_name.xml

Por ejemplo, para apuntar la muestra de clave de API a tu propio servicio de backend, ubica este archivo:

/apikey/apiproxy/targets/default.xml

Si la configuración predeterminada apunta a http://mocktarget.apigee.net, por 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 relación con los servicios de destino existentes. Sin embargo, en algunos casos, el comportamiento del proxy de API depende de formatos específicos de mensajes, por lo que los proxies podrían necesitar cambios de configuración adicionales.