Before you begin
You can create a REST API in the
IBM® Integration Toolkit, as described in
Creating a REST API.
About this task
REST APIs can be deployed to
integration servers that are configured to
use the
integration server HTTP listener. If the
integration node does
not have a queue manager specified, the
integration server defaults to using the
integration server HTTP listener. For more
information on the options for HTTP listeners, see
HTTP listeners.
If you plan to deploy more than one
REST API to an integration server, the
REST APIs must have different base paths.
Procedure
To package a REST API into a BAR file and deploy it to
an integration server, complete the following
steps:
- Package the REST API into a BAR file. You can
use either the BAR file editor, or you can use
the command line. Both the mqsicreatebar and mqsipackagebar commands
package a REST API into a BAR file. When you use these commands, pass
the name of the REST API in as the application name. For
example:
mqsicreatebar -data workspaceDirectory -b restApiName.bar -a restApiName
mqsipackagebar -a restApiName.bar -k restApiName
- Deploy the REST API to the integration server. You can use
the IBM Integration Toolkit, the web user interface,
or the mqsideploy command:
mqsideploy integrationNodeName -e integrationServerName -a restApiName.bar
If
another REST API is deployed to the integration server and that REST API has a
clashing base path, the deployment of the REST API fails. You cannot
deploy REST APIs that have clashing base paths to the same integration server.
Results
Your REST API is deployed.
What to do next
You can view and manage the deployed REST API by using the
command line or a web browser, see
Managing a deployed REST API.