Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Las muestras de la API de Apigee Edge contienen los proxies de la API de muestra, el código, las herramientas y el código que ilustran las capacidades de los servicios de la API de Apigee Edge que se describen a continuación.
Para obtener instrucciones sobre cómo usar las muestras, consulta Usa los proxies de API de muestra.
Aprenda haciendo
¿Quieres meter los brazos en un apuro y comenzar a crear una base de conocimiento sólida sobre Apigee Edge? Tenemos una biblioteca de muestras de “aprendizaje” en GitHub que te permite implementar, invocar y rastrear rápidamente algunos proxies de muestra, desde el proxy más simple hasta los proxies que ilustran la validación de las claves de API, la cuota, el almacenamiento en caché de respuestas, el manejo de errores y mucho más.
Una vez que clones el repositorio y configures tu entorno (solo te llevará unos minutos), puedes probar cada muestra en menos de un minuto. Además, debido a que cada muestra crea una revisión nueva del mismo proxy, tu entorno no se saturará con muchas muestras. Puedes cambiar las revisiones, volver a implementar una revisión diferente en la IU de administración y revisar el código del proxy en cualquier momento. El archivo readme de cada muestra también te ofrece un resumen breve de lo que hace la muestra y cómo se configura.
¡Pruébalo! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Muestras de la guía de soluciones
Se proporciona un conjunto de muestras para los temas de la guía de soluciones del proxy de la API.
| Nombre | Descripción | Tipos de políticas | Recursos |
|---|---|---|---|
| javascript-cookbook | Demuestra un fragmento simple de JavaScript que agrega encabezados HTTP desde variables, transforma un informe meteorológico con formato XML de JSON a XML y corta el contenido para los clientes móviles. | minimiza.js setHeaders.js |
|
| javascript-mashup-cookbook | Una aplicación de JavaScript completa que llama a API públicas, combina 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 el mismo problema se puede abordar con técnicas diferentes). | JavaScript | MashItUp.js |
| java-hello | Texto destacado de Hello World simple de Java. | JavaTexto | JavaHello.java |
| guía-de-cocina | Convierte el contenido y los encabezados de las respuestas en mayúsculas. | JavaTexto |
ResponseUppercase.java |
| java-properties | Demuestra cómo usar las propiedades en un texto destacado de Java. | JavaTexto | JavaProperties.java |
| java-error | Demuestra patrones de manejo de errores que puedes usar en el código de texto destacado de Java. | JavaTexto | JavaError.java |
| policy-mashup-cookbook. | Una aplicación completa que usa composición de políticas a fin de llamar a dos API públicas, combina resultados y genera una respuesta enriquecida para la app cliente. (Nota: Este proxy de API implementa la misma funcionalidad que javascript-mashup, lo que demuestra que se puede abordar el mismo problema con diferentes técnicas). | AssignMessage ServiceTexto 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 saber cómo funciona una política específica 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 las muestras de la guía de soluciones y los proxies de muestra de documentos de las tablas anteriores, las muestras de GitHub de Edge también contienen estos recursos:
| Nombre | Descripción | Tipos de políticas | Recursos |
|---|---|---|---|
| protección de rexos | La política de protección contra amenazas de expresiones regulares puede proteger las APIs y los microservicios de backend de ataques de inyección de SQL. | N/A | |
| oauth-validate-key-secret | Implementarás el flujo de otorgamiento de contraseñas de OAuth. Debes validar la clave y el secreto de cliente de la aplicación en Edge antes de llamar a un proveedor de identidad externo para validar las credenciales del usuario. | OAuthV2, otros | N/A |
| Coincidencia de patrón de condición | Este proxy te permite probar y probar fácilmente las declaraciones condicionales en un flujo de proxy de API. | AssignMessage | N/A |
| entidad-de-acceso | Muestra cómo recuperar perfiles de entidades desde el almacén de datos de Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
ninguno |
| apikey | Implementa una validación de clave de API simple | VerifyAPIKey AssignMessage Cuota |
ninguno |
| texto destacado asíncrono | Demuestra un texto destacado asíncrono simple con el httpClient de JavaScript. | JavaScript | arm_response.js texto destacado.js |
| codificador base64 | Demuestra cómo llamar a JavaScript desde los recursos de JavaScript en proxies de API. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| -condicional-política | Implementa la aplicación condicional de políticas simples. Cuando una solicitud contiene un tiempo de respuesta de encabezado HTTP:verdadero, 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) | temporizador.py |
| dynamic-endpoint | Implementa el enrutamiento condicional simple en una situación un poco más compleja, que define dos URL 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 la versión de Jira. | JSONToXML XSL |
versión.notesnotes.api |
| kerberos-credential-media | En este ejemplo, se muestra cómo realizar la mediación de credenciales de Kerberos en Apigee Edge. | JavaTexto | Archivo JAR de Java |
| avanzado en oauth | 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 | Demuestra 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. En cambio, te recomendamos que consultes el ejemplo 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 a fin de validar las credenciales de los usuarios en el flujo de otorgamiento de contraseña. | OAuthV2 AssignMessage ExtractVariables ServiceCaption RaiseFault |
ninguno |
| oauth-verify-accesstoken | Demuestra un proxy de API que está configurado para validar tokens de acceso de OAuth 2.0 y verificar la cuota. | VerifyAccessToken Cuota |
ninguno |
| oauth10a-3legged | Demuestra una configuración de tres segmentos de OAuth 1.0a. | GenerateAceessToken GenerateRequestToken ServiceTexto VerifyAccessToken |
ninguno |
| outbound-oauth; | Usa la API de traductor de Microsoft Azure para traducir tweets. Para ello, realiza una llamada saliente a fin de 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, que reutiliza el token almacenado en caché cada vez que se realiza una llamada saliente. Además, incluye una app de demostración del navegador 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 proporcionados por el cliente. | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xlsx |
| respuesta-caché | Demuestra cómo almacenar en caché los pronósticos meteorológicos en Edge durante 10 minutos. | ResponseCache Asignar mensaje |
ninguno |
| simple-python | Se muestra una situación simple de adjuntar una secuencia de comandos de Python en la respuesta que le agrega un valor de encabezado. |
Secuencia de comandos (Python) | setHeader.py |
| soap | Demuestra una transformación XSL que reescribe un archivo WSDL en respuesta a una solicitud con el parámetro de búsqueda ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
computeaddress.py fixwsdl.xlsx |
| transmisión | Demuestra una configuración de transmisión HTTP. | ninguno | ninguno |
| Redireccionamiento de destino | Demuestra cómo usar 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 | Demuestra cómo usar JavaScript para quitar los parámetros innecesarios de los tweets, lo que da como resultado un cronograma optimizado para Twitter que es fácil de usar en dispositivos móviles con recursos limitados. | AssignMessage JavaScript |
MobileTimeline.js de |
| twitter-oembed | Transforma las respuestas del cronograma (p.ej., de tener un estado o de un user_timeline.json) en una respuesta oEmbed que contenga los datos del cronograma como contenido HTML enriquecido. | AssignMessage JavaScript |
search-oembed.js |
| variables | Demuestra cómo extraer y configurar variables en función del transporte y el contenido de los mensajes JSON y XML. | AssignMessage ExtractVariables XMLToJSON |
minimiza.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 app y desarrollador. |
||
|
|
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ánea de la organización recupera la configuración de la organización, incluidos los desarrolladores, los productos de API, los hosts virtuales, los mapas de 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 codificador, Apigee-127 te ayuda a programar proxies de API con Node.js y Swagger. También puede encontrar muestras de a127 en GitHub: https://github.com/apigee-127/a127-samples.
Comparte tu experiencia
Comparte tus experiencias en el Foro de desarrolladores de Apigee.