Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
Las muestras de la API de Apigee Edge contienen los proxies, las políticas, el código y las herramientas de la API de muestra que ilustran las capacidades de los servicios de API de Apigee Edge que se describen a continuación.
Para obtener instrucciones sobre el uso de los ejemplos, consulta Usa los proxies de API de muestra.
Aprende haciendo
¿Quieres empezar a trabajar rápidamente y comenzar a crear una base de conocimiento sólida sobre Apigee Edge? Tenemos una biblioteca de muestras de "Learn Edge" en GitHub que te permite implementar, invocar y trazar rápidamente algunos proxies de muestra, comenzando por el más simple y pasando a los proxies que ilustran la validación de claves de API, la cuota, el almacenamiento en caché de respuestas, el manejo de fallas y mucho más.
Una vez que clonas el repositorio y configuras tu entorno (solo lleva unos minutos), puedes probar cada muestra en menos de un minuto. Además, como cada muestra crea una revisión nueva del mismo proxy, tu entorno no se desordenará con muchos ejemplos. Puedes cambiar las revisiones, volver a implementar una revisión diferente en la IU de administración y ver el código de proxy en cualquier momento. El archivo readme de cada ejemplo también te brinda un breve resumen de lo que hace el ejemplo y cómo se configura.
Pruébala. https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Muestras de la guía de soluciones de documentos
Se proporciona un conjunto de muestras para los temas de la guía de soluciones del proxy de API.
| Nombre | Descripción | Tipos de políticas | Recursos |
|---|---|---|---|
| javascript-cookbook | Muestra un fragmento de JavaScript simple que agrega encabezados HTTP a partir de variables, transforma un informe del clima con formato XML de JSON a XML y recorta el contenido para clientes de dispositivos móviles. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | Una aplicación de JavaScript completa que llama a 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 mashup de políticas, lo que demuestra que se puede abordar el mismo problema con diferentes técnicas). | JavaScript | MashItUp.js |
| java-hello | Texto destacado de Java de Hello World simple. | JavaCallout | JavaHello.java |
| java-cookbook | Convierte el contenido y los encabezados de la respuesta a mayúsculas. | JavaCallout |
ResponseUppercase.java |
| java-properties | Demuestra cómo usar propiedades en un texto destacado de Java. | JavaCallout | JavaProperties.java |
| java-error | Muestra los 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 los resultados y genera una respuesta enriquecida para la app cliente. (Nota: este proxy de API implementa la misma funcionalidad que el mashup de JavaScript, lo que demuestra que se puede abordar el mismo problema 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 de instrucciones proporcionan descripciones detalladas de los ejemplos. Si te interesa cómo funciona una política en particular en una muestra, busca la que te interesa en la columna Tipos de políticas que aparece a continuación 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 los documentos).
Referencia y herramientas
Además de los ejemplos de libros de recetas de documentos y los proxies de muestra de las tablas anteriores, los ejemplos de GitHub de Edge también contienen estos recursos:
| Nombre | Descripción | Tipos de políticas | Recursos |
|---|---|---|---|
| protecciónde r | La política de protección contra amenazas de expresiones regulares puede proteger tus APIs y servicios de microservicios de backend de los ataques de inyección de SQL. | N/A | |
| oauth-validate-key-secret | Implementarás 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 sentencias 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 de clave de API simple | VerifyAPIKey AssignMessage Quota |
ninguno |
| async-callout | Se muestra un texto destacado asíncrono simple con el httpClient de JavaScript. | JavaScript | assemble_response.js callout.js |
| base64encoder | Muestra cómo llamar a las incorporaciones de JavaScript desde recursos de JavaScript en proxies de API. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | Implementa la aplicación de políticas condicionales simples. 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. | Secuencia de comandos (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 documentos de Apigee para generar notas de lanzamiento desde 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 en funcionamiento del flujo de tipo de otorgamiento de código de autorización, con Apigee Edge como servidor de autorización |
GenerateAccessToken Muchos más… |
ver 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 | Obsoleta. Te recomendamos que mires la muestra de oauth-advanced. | ||
| 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 que está configurado para validar los tokens de acceso de OAuth 2.0 y verificar la cuota. | VerifyAccessToken Cuota |
ninguno |
| oauth10a-3legged | Se muestra una configuración de tres segmentos de OAuth 1.0a. | 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 | Genera páginas en un mensaje de respuesta XML según los parámetros de límite y desplazamiento que proporciona el cliente. | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | Se muestra cómo almacenar en caché los pronósticos del clima en Edge durante 10 minutos. | ResponseCache AssignMessage |
ninguno |
| simple-python | Muestra una situación simple de cómo adjuntar una secuencia de comandos de Python en la respuesta que le agrega un valor de encabezado. |
Secuencia de comandos (Python) | setHeader.py |
| soap | Muestra una transformación XSL que vuelve a escribir 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 | Demuestra una configuración de transmisión HTTP. | ninguno | ninguno |
| target-reroute | Muestra cómo usar JavaScript para seleccionar de forma dinámica una URL de destino según el 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 genera un cronograma de Twitter optimizado que es compatible con dispositivos móviles con recursos limitados. | AssignMessage JavaScript |
MobileTimeline.js |
| twitter-oembed | Transforma las respuestas de la línea de tiempo (p.ej., de statuses/user_timeline.json) en una respuesta de oEmbed que contiene los datos de la línea de tiempo como contenido HTML enriquecido. | AssignMessage JavaScript |
search-oembed.js |
| variables | Se muestra cómo extraer y configurar variables según el 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 configures proxies de API, políticas, productos de API y perfiles de desarrollador y de 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, los productos de la API, los hosts virtuales, los mapas de par clave-valor, etc. Se puede usar para crear una copia de seguridad de los detalles de una organización o para descubrir la configuración de una organización. |
Apigee-127
Si eres programador, Apigee-127 te permite comenzar a 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.