Publishing projects

Learn to publish a project and make it available for use through gateway or API Manager instance.

About this task

In IBM API Studio, creating an API does not automatically make it accessible. To enable consumption, publish the API to a supported gateway. Currently, you can publish to webMethods API Gateway, DataPower Nano Gateway, and DataPower API Gateway.

Note: Updating an API in the gateway does not sync the changes back to IBM API Studio. Manage API updates within IBM API Studio before redeploying them to the gateway.

Procedure

  1. From the home page, click the API project that you want to publish.
    The project opens in the explorer.
  2. Choose a project or a file inside the project.
    If the selected file has external references, the referenced file is also published along with the selected asset. When duplicate assets are referred, that is when namespace:name:version number is duplicated in the publishing project, then any one gets picked based on the order of creation in the deployment.
  3. Click Publish.
    The Publish project page appears.
  4. Select the publishing target and follow the steps:
    • Publish project to a catalog
    1. On the Publish project page, if no API Manager connection is configured, click Add API Manager and configure the connection. If the connection is disconnected, click Connect to reconnect.
      (This step is applicable for desktop application only.)
    2. Select the required Catalog from the drop-down menu.
    3. Select the required Space from the drop-down menu.
    4. Select one or more gateways from the Available gateways for the selected catalog section. This list shows the gateways configured in the API Manager.
    5. Enable Preserve subscriptions to maintain existing subscriptions when republishing the product.
      This prevents disruption to consumers who have already subscribed.
    6. Click Next.
    7. Select the assets to publish.
    8. Click Publish to publish the project.
    • Deploy project to API gateways (This step is applicable for desktop application only.)
    1. Select Deploy to webMethods gateway.
    2. Choose a gateway from the Select webMethods gateway to deploy section.
      If no gateways are configured, click Configure new gateway and provide the required details to set up a gateway.
    3. Enable Overwrite assets to replace existing assets with identical names on the gateway.
    4. Click Publish.
    5. Enter the Password to complete gateway authentication.
    6. Click Deploy.
    After publishing the project to the gateway or API Manager, test the deployed assets to make sure they work as expected. For details on testing an API, see Running authored tests by using UI.