Implementar una operación en una API REST

Utilice el Editor de API REST de la vista Desarrollo de aplicaciones para implementar operaciones en una API REST.

Antes de empezar

Cree una API REST en IBM® Integration Toolkit, tal como se describe en Creación de una API REST.
Si ha creado la API REST desde cero definiendo recursos, modelos y operaciones (tal como se describe en Creación de una API REST desde cero utilizando IBM Integration Toolkit, también debe definir las operaciones en el editor de API REST. Para obtener información sobre cómo hacerlo, consulte Definición de recursos, modelos y operaciones en una API REST.

Acerca de esta tarea

Las operaciones de una API REST se implementan como un subflujo, y debe utilizar el editor de la API REST para crear un subflujo vacío para cada operación. A continuación, puede implementar la operación añadiendo cualquiera de los nodos de flujo de mensajes IBM Integration Bus estándar al subflujo.

Si no implementa una operación, todavía puede desplegar la API REST en un servidor de integración. Sin embargo, cuando un cliente HTTP intenta llamar a una operación que no se ha implementado,HTTP 501 Not ImplementedEl código de estado se devuelve al cliente.

Procedimiento

Para implementar una operación en una API REST, realice los pasos siguientes:

Abra la API REST que contiene la operación que desea implementar.
Editor de API REST está en el Vista Desarrollo de aplicaciones bajo el proyecto de la API REST.
Localice la operación en el editor de API REST. Las operaciones se listan bajo la cabecera Operaciones y se agrupan por recurso.
La sección Cabecera muestra los detalles del URL base de la API REST.
La sección Recursos muestra las operaciones para cada recurso.
Pulse este botón para crear un subflujo para la operación:. Si ya ha definido un subflujo para la operación, se abrirá dicho subflujo. Al pulsar este botón, se le solicitará que confirme que desea guardar la API REST; esto garantiza que los nodos que añada al subflujo se definan correctamente con la definición actual de la API REST. El subflujo se abre en el Editor de flujos de mensajes y coloca en primer plano.
Utilice la ayuda contextual que se proporciona para cada botón para obtener información sobre la acción asociada.
Implemente la operación añadiendo cualquiera de los nodos de flujo de mensajes IBM Integration Bus estándar al subflujo.
Para obtener más información, consulte Implementación de una operación de API REST utilizando una correlación de mensajes.
Acceda a la información de operación de la API REST, los parámetros de operación de la API REST y el cuerpo de solicitud y respuesta de la API REST, tal como se describe en Implementación del proceso de operación de la API REST en el subflujo utilizando nodos de flujo de mensajes.

Resultados

La operación se ha implementado en la API REST.

Qué hacer a continuación

Debe empaquetar y desplegar la API REST en un servidor de integración, tal como se describe en Empaquetado y despliegue de una API REST.

También puede realizar las siguientes tareas opcionales:

Implementar el manejo de errores para la API REST como un conjunto de subflujos. Para obtener más información, consulte Implementación de un manejador de errores en una API REST.
Proteger la API REST mediante HTTPS cifrando las comunicaciones entre el cliente y el servidor. Para obtener más información, consulte Protección de una API REST utilizando HTTPS.
Proteger la API REST autenticando los usuarios con autenticación básica HTTP. Para obtener más información, consulte Protección de una API REST mediante la autenticación básica HTTP.
Si la API REST va a ser utilizada por el código del lado del cliente que se ejecuta en un navegador web, es posible que tenga que configurar Intercambio de recursos entre orígenes, tal como se describe en Permitir que los navegadores web accedan a una API REST mediante el uso compartido de recursos entre orígenes.
De forma predeterminada las API REST están configuradas para manejar datos JSON. Si desea manejar datos que no son JSON, consulte Manejo de datos no JSON en una API REST.