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 APIs, junto con enlaces a más información.
Las APIs son puntos de entrada para que una aplicación use las funciones de otra. Implementas proxies de API para crear APIs
En Apigee, implementas proxies de API configurando la lógica del proxy de API como una secuencia de pasos que se ejecutan en respuesta a una solicitud del código de cliente. Para exponer un proxy de API a los clientes, debes definir endpoints que incluyan una URL con rutas de recursos, un verbo HTTP, requisitos de cuerpo, etc.
Aunque se llama proxy de API, desde el punto de vista del código de cliente, es la API.
Para obtener una descripción general de los proxies de APIs, consulta el artículo Comprender las APIs y los proxies de APIs.
La secuencia de la lógica del proxy de API se organiza mediante flujos.
En cualquier aplicación, los datos fluyen a través de la aplicación guiados por la lógica de las condiciones. En Apigee, el proceso se compone de flujos. Un flujo es una secuencia de fases (o "pasos") que componen la ruta de procesamiento de un proxy de API. Los flujos son la forma en que Apigee te ofrece lugares para aplicar lógica y comportamiento en puntos específicos desde el cliente hasta el recurso de backend y, después, de vuelta al cliente.
Para obtener más información sobre los flujos, consulta Controlar cómo se ejecuta un proxy con flujos.
Accedes a los datos de estado a través de las variables de flujo creadas por los 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 tus proxies de API y políticas. También puedes acceder a ellas cuando amplías un proxy de API con un lenguaje de procedimiento, como Java, JavaScript o Python.
Apigee se encarga de estas variables. Algunos existen de forma predeterminada, normalmente 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, consulta Gestionar el estado del proxy con variables de flujo.
Puedes hacer que los proxies de API se ejecuten de forma condicional
Al igual que en la mayoría de los lenguajes de programación, en los proxies de API puedes hacer que el código se ejecute de forma condicional. Las condiciones suelen basarse en el estado del proxy de API, al que puedes acceder a través de variables de flujo. Por ejemplo, puedes incluir una condición que compruebe el user-agent y, a continuación, procese la solicitud en consecuencia.
Para obtener más información sobre la ejecución condicional, consulta Condiciones con variables de flujo.
La mayoría de la lógica de un proxy de API se implementa mediante políticas.
La mayor parte de la lógica que añades 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 gestión del tráfico. Configuras una política con XML que define las propiedades de la lógica subyacente. Las políticas se organizan en una secuencia de "pasos" dentro de un flujo, de forma que el proxy de API ejecute la lógica en el mejor orden para los objetivos del proxy.
Para obtener más información sobre las políticas, consulta ¿Qué es una política?
Puedes incluir conjuntos reutilizables de funciones
Cuando tu proxy de API incluye lógica que se usará desde varios lugares de tu código (por ejemplo, otros proxies de API), puedes recopilar esa lógica para las llamadas desde varios lugares. Por ejemplo, puedes agrupar la lógica de seguridad en un flujo compartido al que llamen otros proxies de API, lo que reduce la duplicación entre proxies de API.
Para obtener más información sobre los flujos compartidos, consulta el artículo Flujos compartidos reutilizables. Para obtener más información sobre la creación de cadenas entre proxies de APIs, consulta el artículo Crear cadenas entre proxies de APIs.
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 de tu proxy de API al depurar y probar. La herramienta muestra visualmente cada paso del proxy de API que se ejecuta para una solicitud. Al igual que en un depurador, en cada paso puede ver la lista de valores de variables que componen 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.
Gestionas los errores de los proxies de APIs como fallos
Si configuras un controlador de errores, puedes personalizar el error que se devuelve a un cliente de la API. Los controladores de errores te permiten controlar los mensajes de error, tanto si el error procede de tu propio código como de un componente incluido (como una política).
Para obtener más información, consulta Gestión de errores.