Se usó la API de Cloud Translation para traducir esta página.

Lista de muestras

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Los ejemplos 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 cómo usar los ejemplos, consulta Cómo usar los proxies de API de muestra.

Aprende haciendo

¿Quieres ponerte manos a la obra rápidamente y comenzar a crear una base de conocimiento sólida sobre Apigee Edge? Contamos con una biblioteca de ejemplos de “aprendizaje perimetral” en GitHub que te permiten implementar, invocar y rastrear rápidamente algunos proxies de muestra. Comienza con el proxy más simple y continúa con los proxies que ilustran la validación de la clave de API, la cuota, el almacenamiento en caché de las respuestas, el manejo de errores y mucho más.

Una vez que clones el repositorio y configures tu entorno (lo que te llevará solo unos minutos), podrás 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 desordenará con muchas muestras. Puedes cambiar de revisión, volver a implementar otra revisión 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 resumen breve de lo que hace la muestra y de cómo se configura.

Pruébalo: https://github.com/apigee/api-platform-samples/tree/master/learn-edge

Muestras de documentos de recetas

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	Se muestra un fragmento de JavaScript simple que agrega encabezados HTTP desde variables, transforma un informe meteorológico con formato XML de JSON a XML y recorta el contenido de los clientes móviles.	Javascript XMLToJSON	minimiza.js setHeaders.js
javascript-mashup-cookbook	Una aplicación completa de JavaScript que llama a las 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 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 simple de Hello World de Java.	JavaCallout	JavaHello.java
java-cookbook	Convierte el contenido y los encabezados de las respuestas en mayúsculas.	JavaCallout	ResponseUppercase.java
java-properties	Demuestra cómo usar las propiedades en un texto destacado de Java.	JavaCallout	JavaProperties.java
java-error	Demuestra los patrones de manejo de errores que puedes usar en el código del 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 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 readme proporcionan descripciones detalladas de las muestras. Si te interesa saber 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 las muestras del documento de recetas y los proxies de muestra de las tablas anteriores, las muestras de GitHub de Edge también contienen estos recursos:

Nombre	Descripción	Tipos de políticas	Recursos
r egex-protection	La política de protección contra amenazas de expresiones regulares puede proteger tus APIs de backend y microservicios de ataques por inyección de SQL.	Protección contra expresiones regulares	No disponible
oauth-validate-key-secret	Estás implementando el flujo de tipos de otorgamiento de contraseña 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	No disponible
condition-pattern-matching	Este proxy te permite probar y probar fácilmente las declaraciones condicionales en un flujo de proxy de API.	AssignMessage	No disponible
ent-entidad-de-acceso	Muestra cómo recuperar perfiles para las 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 Cuota	ninguno
async-callout.	Demuestra un texto destacado asíncrono simple con el httpClient de JavaScript.	JavaScript	compose_response.js call.js
base64encoder	Demuestra cómo llamar a inclusiones 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
condicional-policy	Implementa la aplicación forzosa de políticas condicional simple. Cuando una solicitud contiene un encabezado de respuesta 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 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	releasenotes_api.xsl
kerberos-credential-mediation	En esta muestra, 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 GenerateAuthCode RefreshAccessToken Muchas más...	consulta el código de ejemplo
oauth-client-credentials	Muestra un extremo del token de OAuth 2.0 completamente funcional y 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 la muestra oauth-advanced.
oauth-validate-key-secret	Muestra 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 usuario en el flujo de tipo de otorgamiento de contraseñas.	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 Cuota	ninguno
oauth10a-3legged	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 tweets. Para ello, realiza una llamada saliente a fin de obtener un token de acceso de OAuth y, luego, almacena en caché el token con las políticas de almacenamiento en caché de los Servicios de API y reutiliza el token almacenado en caché cada vez que se realiza una llamada saliente. Además, se incluye una app de navegador de demostración que se utiliza 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 según los parámetros de límite y desplazamiento que proporciona el cliente	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
caché-de-respuestas	Muestra cómo almacenar en caché los pronósticos del clima en Edge durante 10 minutos.	ResponseCache AssignMessage	ninguno
simple-python	Se muestra una situación simple en la que se adjunta 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 reescribe un archivo WSDL en respuesta a una solicitud con el parámetro de consulta ?wsdl.	AssignMessage ExtractVariables Secuencia de comandos (Python) XSL	computeaddress.py Fixwsdl.xsl
de transmisión	Muestra una configuración de transmisión HTTP.	ninguno	ninguno
target-reroute	Se muestra 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 parámetros innecesarios de los tweets, lo que da como resultado un cronograma de Twitter optimizado que es compatible con dispositivos móviles con recursos limitados.	AssignMessage JavaScript	MobileTimeline.js
twitter-oembed	Transforma las respuestas del cronograma (p.ej., de status/user_timeline.json) en una respuesta oEmbed que contiene los datos del cronograma como contenido HTML enriquecido.	AssignMessage JavaScript	search-oembed.js
variables	Demuestra 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 las respuestas de XML a JSON.	XMLToJSON JSONToXML	ninguno
`/schemas`	Archivos de esquema XML que puedes usar como referencia cuando configuras proxies de API, políticas, productos de API y perfiles de desarrollador y app.
`/tools`	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.
`/org-snapshot`	La herramienta de instantáneas 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 descubrir su configuración.

Apigee-127

Si eres codificador, Apigee-127 te ayuda a programar 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 de desarrolladores de Apigee.