Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
En este tema, se enumeran algunas características básicas de los proxies de API y los vínculos para acceder a más información.
Las API son puntos de entrada para que una aplicación use las capacidades de otra. Implementa proxies de API para crear las API
En Apigee, debes implementar proxies de API mediante la configuración de la lógica de proxy de API como una secuencia de pasos que se ejecutan en respuesta a una solicitud desde el código cliente. Expones un proxy de API a los clientes mediante la definición de extremos que incluyen una URL con rutas de recursos, un verbo HTTP, requisitos de cuerpo, etcétera.
Si bien se llama proxy de API, desde la perspectiva del código del cliente, es la API.
Para obtener una descripción general de los proxies de API, consulta Información sobre las API y los proxies de API.
Debes organizar la secuencia de lógica del proxy de API mediante flujos
En cualquier aplicación, los datos fluyen a través de la aplicación guiada por la lógica de condición. En Apigee, la ruta de procesamiento está conformada por flujos. Un flujo es una secuencia de etapas (o "pasos") que conforman la ruta de procesamiento de un proxy de API. Los flujos son la forma en que Apigee brinda lugares para que apliques lógica y comportamiento en lugares específicos del recurso de cliente al recurso de backend y, luego, de nuevo al de cliente.
Para obtener más información sobre los flujos, consulta Controla cómo se ejecuta un proxy con flujos.
Puedes acceder a los datos de estado a través de variables de flujo creadas por proxies de API
Un proxy de API tiene acceso a variables que representan el estado de ejecución. Puedes acceder a estas variables desde el XML que configura los proxies y políticas de tu API. También puedes acceder a ellas cuando extiendas un proxy de API con un lenguaje de procedimiento, como Java, JavaScript o Python.
Apigee mantiene estas variables. Algunas existen de forma predeterminada, por lo general, porque son comunes a lo que hacen los proxies de API (por ejemplo, porque forman parte de una solicitud HTTP). También puedes crear tus propias variables para satisfacer un requisito lógico.
Para obtener más información sobre las variables de flujo, consulta Administra el estado del proxy con variables de flujo.
Puedes hacer que los proxies de API se ejecuten de forma condicional
Como en la mayoría de los lenguajes de programación, en los proxies de API, puedes ejecutar código de manera condicional. Las condiciones suelen basarse en el estado del proxy de API, al que puedes acceder a través de las variables de flujo. Por ejemplo, puedes tener una condición que compruebe el usuario-agente y, luego, procese la solicitud según corresponda.
Para obtener más información sobre la ejecución condicional, consulta Condiciones con variables de flujo.
Implementas la mayor parte de la lógica en un proxy de API mediante el uso de políticas
La mayor parte de la lógica que se agrega a un proxy de API se empaqueta como políticas. Una política es un componente de Apigee que encapsula la lógica de un área funcional, como la seguridad o la administración del tráfico. Configura una política con XML que establezca propiedades para la lógica subyacente. Organiza las políticas en una secuencia de “pasos” dentro de un flujo, para que el proxy de la API ejecute la lógica en el mejor orden según los objetivos de tu proxy.
Para obtener más información, consulta ¿Qué es una política?.
Puedes incluir conjuntos de funcionalidades reutilizables
Cuando el proxy de tu API incluye una lógica que se utilizará desde varios lugares en tu código, como otros proxies de API, puedes recopilar esa lógica para llamadas de varios lugares. Por ejemplo, puedes agrupar la lógica de seguridad en un flujo compartido al que llaman otros proxies de API, lo que reduce la duplicación en los proxies de API.
Para obtener más información sobre flujos compartidos, consulta Flujos compartidos reutilizables. Para obtener más información sobre el encadenamiento de proxy de API, consulta Encadena proxies de API.
Puedes depurar un proxy con la herramienta de depuración
Apigee incluye una herramienta de depuración que puedes usar para examinar el flujo de ejecución del proxy de API cuando realizas depuraciones y pruebas. La herramienta presenta de manera visual cada paso del proxy de API que se ejecuta para una solicitud. Al igual que en un depurador, en cada paso puedes ver la lista de valores de variables que conforman el estado del proxy de API.
Para obtener más información sobre la depuración con la herramienta de depuración, consulta Herramienta de depuración.
Manejas errores de proxy de API como fallas
Mediante la configuración de un controlador de fallas, puedes personalizar el error que se muestra a un cliente de la API. Los controladores de fallas te brindan control sobre los mensajes de error, ya sea que el error se origine en tu propio código o en un componente incluido (como una política).
Para obtener más información, consulta Soluciona fallas.