El editor de ensamblaje
API Designer de IBM® API Connect presenta un editor gráfico que puede utilizar para crear ensamblados. Con los conjuntos, puede adaptar fácilmente las API para incluir elementos tales como el registro de actividad y la redacción de campos específicos.
- Paleta: muestra los elementos disponibles en el flujo de ensamblaje.
- Lienzo: se utiliza para organizar y visualizar los elementos del ensamblaje.
- Ficha de propiedades: se utiliza para configurar los elementos del ensamblaje.
La paleta
La paleta es una lista de diversos elementos que puede incluir en el ensamblaje. Para ver la paleta, haz clic en el icono del 
signo más en el lienzo. Puedes utilizar el icono de rotación 
para girar la paleta como prefieras. Para maximizar y minimizar la vista de la paleta, haz clic en los iconos de maximizar y minimizar.
Puedes cerrar la paleta haciendo clic en el icono de 
Cerrar.
El lienzo
Puede utilizar el lienzo para crear una representación gráfica del flujo de ensamblaje. Para añadir un elemento al flujo de montaje desde la paleta, haz clic en el icono con el signo más en la ubicación adecuada del lienzo y selecciona el elemento deseado de la lista disponible. Para eliminar un elemento del lienzo, pasa el cursor por encima del elemento y haz clic en el icono de eliminar 
.
Las llamadas de API se realizan en el círculo inicial vacío y se devuelven en el círculo final rellenado. Puede insertar elementos entre los dos círculos para modificar los datos recibidos de la llamada o devueltos por la respuesta.
Puede utilizar el conmutador Mostrar capturas para mostrar y ocultar capturas de errores en la paleta. Una captura es una sección del ensamblaje que se aplica cuando una llamada de API provoca la devolución del código de estado HTTP correspondiente. Pulse la sección captura para abrir la hoja de propiedades de todas las capturas.
Puede acercar y alejar la vista del lienzo pulsando los iconos + y - . Para ajustar el lienzo al tamaño de la pantalla, haz clic en el icono «Ajustar a 
la pantalla».
La hoja de propiedades
Al seleccionar un elemento del ensamblaje haciendo clic en él, se muestran los detalles de dicho elemento en la hoja de propiedades. En este panel, puede configurar las propiedades del elemento. Las opciones disponibles en la hoja de propiedades dependen del tipo de elemento con el que estés trabajando. Para algunos elementos, puede añadir y eliminar propiedades pulsando Propiedades de objeto y seleccionando la propiedad en el menú desplegable.
Puedes cerrar la hoja de propiedades haciendo clic en el icono de Cerrar.
El comportamiento de un ensamblaje
El ensamblaje ejecuta políticas por orden y actúa en distintos contextos de la llamada de API. Cuando se realiza una llamada de API, los límites de seguridad y de velocidad se aplican antes de que se ejecute el ensamblaje. Durante el ensamblaje, el flujo se puede bifurcar, lanzar y capturar según las políticas disponibles. El contexto del mensaje recorre el conjunto, donde es utilizado y modificado por diversas políticas. Además del mensaje, es posible acceder a otros contextos y crearlos.
- Seguridad y limitación de velocidad
- Antes de ejecutar el ensamblaje se impone seguridad y después límites de velocidad.
Primero, las definiciones de seguridad y el control de acceso CORS se utilizan para autenticar una llamada de API. Cualesquiera definiciones de seguridad de Clave de API se utilizan para identificar aplicaciones que tengan suscripciones a un producto que contenga la API. Si una definición de seguridad no permite el acceso, se rechaza la llamada de API.
Si una aplicación se identifica por el ID de cliente o el secreto de cliente correspondiente, se puede imponer un límite de velocidad según el plan o la operación llamados.
- La secuencia de ejecución de ensamblaje
- El ensamblaje se ejecuta por orden desde el círculo lleno inicial al círculo vacío final. Sin embargo, existe la posibilidad de realizar ramificaciones cuando se utilizan construcciones
iflógicasoperation-switchy, o de que el código ensamblador restante se ignore al ejecutarse unathrowpolítica.El mensaje es el contexto sobre el que actúa cualquier política que no esté configurada de otra manera. Al inicio de la llamada a la API, el mensaje está vacío y, al final de la llamada, el mensaje se utiliza como respuesta.
El contexto de la solicitud contiene la información enviada por el usuario de la API y varía en función del tipo de operación solicitada y de la configuración de dicha operación. Por ejemplo, una operación GET nunca puede tener un
request.bodylleno y puede configurar una operación para tenerrequest.parameters(parámetros de consulta). La primera política de un ensamblaje actúa sobre la solicitud y genera la primera instancia del mensaje. Si no hay políticas, la solicitud se devuelve al emisor de la llamada. - Gestión de contextos
- Dado que el mensaje puede sobrescribirse, es recomendable crear y hacer referencia a nuevos contextos siempre que sea posible, de modo que se guarden y se puedan reutilizar durante la llamada a la API.
- Utilice la
mappolítica para sobrescribir el contexto del mensaje cuando necesite ejecutar una política que solo actúe sobre el mensaje. - Utilice el contexto de solicitud que desea que utilice la solicitud original realizada a la API.
- Utiliza las políticas
map,invokeproxy, y para crear nuevos contextos cuando quieras guardar tu mensaje.Nota: Al crear un contexto nuevo, a menos que también esté correlacionando con el mensaje, el mensaje se sobrescribe con un objeto vacío.
Por ejemplo,
invokees la primera política de la secuencia y su respuesta sobrescribe la solicitud como mensaje. A continuación, unavalidatepolítica procesa el mensaje, y dichamappolítica guarda el mensaje como un nuevo contexto, listo para que una segundainvokepolítica sobrescriba el mensaje sin perder el resultado de la primerainvokepolítica.También puedes acceder a contextos ajenos al mensaje o a tus contextos personalizados, pero no es posible escribir en ellos. Para ver una lista de contextos, consulta las variables de contexto de API Connect.
- Utilice la
- Ramas y capturas
- Mediante el uso de constructos lógicos, como
operation-switchoif, puedes ejecutar diferentes secciones del ensamblado cuando se cumplen determinadas condiciones. Cuando el ensamblaje se ramifica, la subsección del ensamblaje contenido por la construcción se ejecuta de la misma manera que un ensamblaje completo. Sin embargo, los contextos se comparten con el ensamblaje completo.Cuando se activa una excepción, ya sea por un error que se produce durante la ejecución de una política o porque se encuentra una
throwpolítica, se ignora el resto del flujo de ensamblaje. Todos los contextos están compartidos por la captura que se ejecuta y cuando se alcanza el final de la captura, la llamada de API se completa. No hay forma de volver de una captura al resto del ensamblaje.