Publishing Assets to API Gateway

Using Designer, you can publish REST API descriptors and web service descriptors created on Integration Server to API Gateway.

In addition to publishing new REST API descriptors and web service descriptors to API Gateway, you can also update the details of an already published descriptor. However, you cannot use Designer to retract an already published descriptor from API Gateway. Instead, use API Gateway to delete the published descriptors.

You can specify an API name and version when you publish or republish a descriptor. This API name and version can be different from those given in the descriptor.

Before you can publish REST API descriptors and web service descriptors to API Gateway, you must define a connection configuration in Designer. For information about working with connection configurations for API Gateway, see Publishing Assets to webMethods API Gateway.

1. In the Package Navigator view of Designer, right-click the REST API descriptor or web service descriptor you want to publish and select Publish.

If you want to publish multiple REST API descriptors or web service descriptor in a folder or a package, right-click the particular folder or package and select Publish.

Note:
If you want to update details of a REST API descriptor or web service descriptor that is already published to API Gateway, you can select the particular descriptor for publishing. In such a situation, Integration Server overwrites the existing details for that descriptor on API Gateway.

2. In the Asset Publish dialog box, select API Gateway as the destination for publishing the descriptors and click Next.

The Publish Assets to API Gateway dialog box appears. It lists the descriptors you selected in step 1 along with the API name and version. If you selected a folder or a package, all the descriptors in the particular folder or package are selected in the dialog box. The Publish Assets to API Gateway dialog box displays the default API name and version of the descriptor. However, if the descriptor was published before, then the Publish Assets to API Gateway dialog box displays the published API name and version.

3. In the Publish Assets to API Gateway dialog box, select the descriptors that you want to publish. Optionally, you can provide an API name and version for the selected descriptor.

The publish process starts for the REST API descriptors and web service descriptors that you selected. Designer displays the results of the publish process for the selected descriptors on the Published Metadata screen.

Note:
For information about the errors that occur during the publish process, see the Integration Server server log.