Estás viendo la documentación de Apigee Edge.
Ir a la
documentación de Apigee X. info
Las muestras de la API de Apigee Edge contienen los proxies de API, las políticas, el código y las herramientas de muestra que ilustran las capacidades de los servicios de la API de Apigee Edge que se describen a continuación.
Para obtener instrucciones sobre el uso de las muestras, consulta Usa los proxies de API de muestra.
Aprende haciendo
¿Quieres ponerte manos a la obra rápidamente y comenzar a crear una base de conocimientos sólida sobre Apigee Edge? Tenemos una biblioteca de muestras de "learn-edge" en GitHub que te permite implementar, invocar y rastrear rápidamente algunos proxies de muestra, comenzando con el proxy más simple y pasando a los proxies que ilustran la validación de la clave de API, la cuota, el almacenamiento en caché de la respuesta, el manejo de fallas y mucho más.
Una vez que clones el repositorio y configures tu entorno (solo tardará unos minutos), podrás probar cada muestra en menos de un minuto. Además, como cada muestra crea una nueva revisión del mismo proxy, tu entorno no se llenará de muchas muestras. Puedes cambiar las revisiones, volver a implementar una revisión diferente en la IU de administración y consultar el código del proxy en cualquier momento. El archivo README de cada muestra también te brinda un breve resumen de lo que hace la muestra y cómo está configurada.
Pruébalo. https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Ejemplos de la guía de soluciones de documentos
Se proporciona un conjunto de muestras para los temas de la guía de soluciones de proxy de API.
| Nombre | Descripción | Tipos de políticas | Recursos |
|---|---|---|---|
| javascript-cookbook | Muestra un fragmento de JavaScript simple que agrega encabezados HTTP de variables, transforma un informe meteorológico con formato XML de JSON a XML y recorta el contenido para clientes móviles. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | Una aplicación JavaScript completa que llama a las APIs públicas, combina los resultados y genera una respuesta enriquecida para la app cliente. (Nota: Este proxy de API implementa la misma funcionalidad que el policy-mashup, lo que demuestra que el mismo problema se puede abordar con diferentes técnicas). | JavaScript | MashItUp.js |
| java-hello | Llamada de código Java simple de Hello World. | JavaCallout | JavaHello.java |
| java-cookbook | Convierte el contenido y los encabezados de la respuesta a mayúsculas. | JavaCallout |
ResponseUppercase.java |
| java-properties | Muestra cómo usar las propiedades en una llamada de código Java. | JavaCallout | JavaProperties.java |
| java-error | Muestra patrones de manejo de errores que puedes usar en el código de texto destacado de Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Una aplicación completa que usa la composición de políticas para llamar a dos APIs públicas, combina resultados y genera una respuesta enriquecida para la app cliente. (Nota: Este proxy de API implementa la misma funcionalidad que el javascript-mashup, lo que demuestra que el mismo problema se puede abordar con diferentes técnicas). | AssignMessage ServiceCallout ExtractVariables JavaScript XMLToJSON |
GenerateResponse.js |
Proxies de API de muestra
Los siguientes proxies de API se encuentran en GitHub, donde las páginas README proporcionan descripciones detalladas de las muestras. Si te interesa cómo funciona una política en particular en una muestra, busca en la columna Tipos de políticas a continuación la que te interesa y, luego, haz clic en el nombre de la muestra en la columna Nombre. (Las políticas están vinculadas a sus respectivas páginas de referencia en la documentación).
Referencia y herramientas
Además de las muestras de la guía de soluciones de documentos y los proxies de muestra en las tablas anteriores, las muestras de GitHub de Edge también contienen estos recursos:
| Nombre | Descripción | Tipos de políticas | Recursos |
|---|---|---|---|
| regex-protection | La política de protección contra amenazas de expresiones regulares puede proteger tus APIs de backend y microservicios de los ataques de inyección de SQL. | N/A | |
| oauth-validate-key-secret | Estás implementando el flujo de tipo de otorgamiento de contraseña de OAuth. Debes validar la clave y el secreto del cliente de la aplicación en Edge antes de llamar a un proveedor de identidad externo para validar las credenciales del usuario. | OAuthV2 y otros | N/A |
| condition-pattern-matching | Este proxy te permite probar fácilmente las instrucciones condicionales en un flujo de proxy de API. | AssignMessage | N/A |
| access-entity | Muestra cómo recuperar perfiles de entidades del almacén de datos de Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
ninguno |
| apikey | Implementa una validación simple de la clave de API. | VerifyAPIKey AssignMessage Quota |
ninguno |
| async-callout | Muestra un texto destacado asíncrono simple con httpClient de JavaScript. | JavaScript | assemble_response.js callout.js |
| base64encoder | Muestra cómo llamar a las inclusiones de JavaScript desde los recursos de JavaScript en los proxies de API. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | Implementa una aplicación simple de políticas condicionales. Cuando una solicitud contiene un encabezado HTTP responsetime:true, una política ejecuta una secuencia de comandos de Python que agrega un conjunto de métricas de rendimiento al mensaje de respuesta, como encabezados HTTP. | Script (Python) | timer.py |
| dynamic-endpoint | Implementa un enrutamiento condicional simple en una situación un poco más compleja, que define dos URLs y una ruta predeterminada. | ninguno | ninguno |
| jira-release-notes | Este es el proxy de API que usa el equipo de documentación de Apigee para generar notas de la versión de Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | En este ejemplo, se muestra cómo realizar la mediación de credenciales de Kerberos en Apigee Edge. | JavaCallout | Archivo JAR de Java |
| oauth-advanced | Un ejemplo completo y funcional del flujo de tipo de otorgamiento de código de autorización, con Apigee Edge como servidor de autorización. |
GenerateAccessToken Muchos otros... |
consulta el código de ejemplo |
| oauth-client-credentials | Muestra un extremo de token de OAuth 2.0 completamente funcional configurado para el tipo de otorgamiento de credenciales de cliente. | GenerateAccessToken | ninguno |
| oauth-login-app | Ya no está disponible. Te recomendamos que consultes la muestra oauth-advanced en su lugar. | ||
| oauth-validate-key-secret | Ilustra una técnica para validar la clave y el secreto del cliente antes de llamar a un proveedor de identidad para validar las credenciales del usuario en el flujo de tipo de otorgamiento de contraseña. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
ninguno |
| oauth-verify-accesstoken | Muestra un proxy de API configurado para validar tokens de acceso de OAuth 2.0 y verificar la cuota. | VerifyAccessToken Quota |
ninguno |
| oauth10a-3legged | Muestra una configuración de OAuth 1.0a de tres segmentos. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
ninguno |
| outbound-oauth | Usa la API de Microsoft Azure translator para traducir los tweets. Para ello, realiza una llamada saliente para obtener un token de acceso de OAuth y, luego, almacena en caché el token mediante las políticas de almacenamiento en caché de los servicios de API y vuelve a usar el token almacenado en caché cada vez que se realiza una llamada saliente. Además, incluye una app de navegador de demostración que se usa para invocar el proxy de API. | AssignMessage LookupCache PopulateCache JavaScript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| Paginación | Pagina un mensaje de respuesta XML en función de los parámetros de límite y desplazamiento que proporciona el cliente. | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | Muestra cómo almacenar en caché los pronósticos meteorológicos en Edge durante 10 minutos. | ResponseCache AssignMessage |
ninguno |
| simple-python | Muestra una situación simple de adjuntar una secuencia de comandos de Python en la respuesta que le agrega un valor de encabezado. |
Script (Python) | setHeader.py |
| soap | Muestra una transformación de XSL que reescribe un archivo WSDL en respuesta a una solicitud con el parámetro de consulta ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
| Transmisión | Muestra una configuración de transmisión HTTP. | ninguno | ninguno |
| target-reroute | Muestra el uso de JavaScript para seleccionar de forma dinámica una URL de destino en función del contenido de un mensaje de solicitud. | ExtractVariables JavaScript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | Muestra cómo usar JavaScript para quitar los parámetros innecesarios de los tweets, lo que da como resultado una cronología de Twitter optimizada que es adecuada para dispositivos móviles con recursos limitados. | AssignMessage JavaScript |
MobileTimeline.js |
| twitter-oembed | Transforma las respuestas de la cronología (p.ej., de statuses/user_timeline.json) en una respuesta oEmbed que contiene los datos de la cronología como contenido HTML enriquecido. | AssignMessage JavaScript |
search-oembed.js |
| variables | Muestra cómo extraer y configurar variables en función del transporte y el contenido de los mensajes JSON y XML. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | Convierte los datos de respuesta de XML a JSON. | XMLToJSON JSONToXML |
ninguno |
|
|
Archivos de esquema XML que puedes usar como referencia cuando configuras proxies de API, políticas, productos de API y perfiles de desarrolladores y apps. |
||
|
|
Contiene una herramienta de implementación, deploy.py, que importa un proxy de API a una organización en Apigee Edge y, luego, lo implementa en el entorno especificado. |
||
|
|
La herramienta de instantáneas de la organización recupera la configuración de la organización, incluidos los desarrolladores, productos de API, hosts virtuales, mapas clave-valor, etc. Se puede usar para hacer una copia de seguridad de los detalles de una organización o para descubrir la configuración en una organización. |
Apigee-127
Si eres programador, Apigee-127 te permite codificar proxies de API con Node.js y Swagger. También puedes encontrar muestras de a127 en GitHub: https://github.com/apigee-127/a127-samples.
Comparte tu experiencia
Comparte tus experiencias en el Foro para desarrolladores de Apigee.