Publishing Assets to webMethods API Gateway

Designer helps you publish REST API descriptors and web service descriptors created on Integration Server to API Gateway. API Gateway enables organizations to securely expose different types of APIs to external users. Before you can publish the REST API descriptors and web service descriptor, you must configure a connection to API Gateway.

Configuring a Connection to API Gateway

About this task

You need to provide configuration information in Designer to a connection to API Gateway. Designer saves this information in a connection configuration. You can add, edit, and remove connection configurations in Designer.

Before you configure a connection to API Gateway, ensure that the following criteria are met:

  • API Gateway is already installed and information about the host address and the port on which API Gateway is running are available.
  • A valid user account exists on API Gateway.
Using Designer you can add connections configurations for API Gateway.

To add a connection configuration for API Gateway

Procedure

  1. In Designer, select Window > Preferences.
  2. In the preferences navigation tree, select Software AG > API Gateway .
  3. Click Add.
  4. In the Add Connection Configuration dialog box, enter the following information:
    Field Description
    Name The name to use for the connection configuration.
    Note: The name cannot contain special characters, and characters outside of the basic ASCII character set, such as multi-byte characters.
    Host The host name of API Gateway.
    Port The port number on API Gateway for the connection configuration.
    User The name of a valid user account on API Gateway.
    Password The password for the specified User.

    If required, you can omit the password at this time. In such a situation, Designer prompts for the password each time your user authorization is required for connecting to API Gateway.

    Save password (in the Eclipse secure storage) Indicates whether the password for the specified user account should be saved in Eclipse secure storage. API Gateway uses this password from the Eclipse secure storage whenever user authorization is required. If you want to save the password in Eclipse secure storage, select this check box.

    If you decide not to save the password in Eclipse secure storage, you must specify your password each time your user authorization is required for connecting to API Gateway.

    Secure connection

    Indicates whether the session for connection to API Gateway is through HTTP or HTTPS. If you want to open an HTTPS session by using the Secure Socket Layer (SSL), select this check box. If you want to open an HTTP session, clear this check box.

  5. To verify whether API Gateway can be accessed by using the specified configuration, click Test.
  6. To store the connection configuration details, click OK.
    A connection configuration is added to the Connections page with the specified details. The first connection configuration that you create is automatically marked as default. This default configuration is indicated with a check mark on the Connections page. Designer always uses the default connection configuration for API Gateway.

Editing a Connection Configuration for API Gateway

About this task

You can edit a connection configuration for API Gateway if there are any changes in the configuration values.

To edit a connection configuration for API Gateway

Procedure

  1. In Designer, select Window > Preferences.
  2. In the preferences navigation tree, select Software AG > API Gateway.
  3. Click Edit.
  4. Enter new values in the connection configuration fields you want to change.
  5. In the Edit Connection Configuration dialog box, click OK.
  6. In the Connections page, click OK.

Removing a Connection Configuration for API Gateway

About this task

You can remove connection configurations for API Gateway one at a time from the Connections page. You cannot remove the default connection configuration.

To remove a connection configuration for API Gateway

Procedure

  1. In Designer, select Window > Preferences
  2. In the preferences navigation tree, select Software AG > API Gateway.
  3. Select the API Gateway connection configuration you want to remove.
  4. Click Remove.

    Designer prompts you to confirm that you want to remove the selected connection configuration.

  5. Click OK.

Changing the Default Connection Configuration for API Gateway

About this task

When connecting to API Gateway, Designer always uses the default connection configuration. Therefore, a connection configuration must always be marked as default on the Connections page.

To change the default connection configuration for API Gateway

Procedure

  1. In Designer, select Window > Preferences
  2. In the preferences navigation tree, select Software AG > API Gateway.
  3. Select the Default check box for the connection configuration you want to be the default.

    Designer prompts you to confirm that you want to replace the existing default with the new one.

  4. Click OK.

Publishing Assets to API Gateway

About this task

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.

To publish the REST API descriptor and web service descriptor to API Gateway

Procedure

  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.
  4. Click Finish to publish or republish the selected descriptors.
    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.