Publishing APIs to Developer Portal

Edit online

Publishing an API to webMethods Developer Portal sends the SOAP and REST APIs to webMethods Developer Portal on which they are exposed for testing and user consumption.

Before you begin

When you publish an API to the webMethods Developer Portal destination, keep the following points in mind:
  • The Developer Portal destination must be configured in webMethods API Gateway.
  • You must have the Publish to webMethods Developer Portal functional privilege.
  • You cannot publish an API if it is in an inactive state. Activate the API before publishing.

About this task

To publish an API to the webMethods Developer Portal, the webMethods API Gateway initiates the process, which is then executed on the webMethods Developer Portal server.

Note: webMethods API Gateway does not support publishing GraphQL API to webMethods Developer Portal.

Procedure

  1. Open the menu options and select an API. A list of all APIs appears.
  2. You can publish one API to webMethods Developer Portal at a time or multiple APIs simultaneously.
    Publish an API to webMethods Developer Portal.
    1. Open the menu options and select an API. A list of all APIs appears.
    2. Click the Publish icon for the API you want to publish.
    3. Select the API endpoints that need to be visible to the consumers. At least one endpoint must be selected prior to publishing the API.
    4. Select the API type if you want to publish a REST-enabled SOAP API. When the REST transformation is enabled for a SOAP API in webMethods API Gateway, you can publish the REST-enabled SOAP API to Developer Portal in one of the following ways.
      • Publish as REST. Default. The API is published as a REST API to webMethods Developer Portal. The REST resources and methods that correspond to the transformed SOAP operations are also published to webMethods Developer Portal.
      • Publish as SOAP. The API is published as a SOAP API with the SOAP operations to webMethods Developer Portal.
      • Publish as REST and SOAP. When both options are selected, the API is published as both a REST and SOAP API in the webMethods Developer Portal and marked as HYBRID.
      Note: The Publish as option is available only if the REST transformation is enabled for the SOAP API.
    5. Select the communities to which the API needs to be published. By default, an API is published to the Public Community of webMethods Developer Portal.
      Note: If an API is already a part of the package that is published to a community, then you cannot remove it from that community.
    6. Click Publish. The API along with the selected endpoints is published to webMethods Developer Portal and available for the consumers to consume it.

      A REST-enabled SOAP API is published to webMethods Developer Portal based on the selected API type.

      • REST API. The API Details view displays the published API as a REST API with the defined REST resources and methods.
      • SOAP API. The API Details view displays the published API as a SOAP API with the defined SOAP operations.
      • HYBRID API. The API Details view, by default, displays the published API as a REST API with the REST resources and methods. There is an option SOAP that can be selected to display the published API as a SOAP API with the SOAP operations.

      Once an API is published, the Publish icon changes to the Republish icon.

    Publish multiple API to webMethods Developer Portal in single operation.
    1. Select the APIs that you want to publish from. By default, all the respective API endpoints are internally selected to be visible to the consumers.
    2. Click drop down from Setting icon, and click Publish.
    3. Select the communities to which the APIs must be published. By default, the APIs are published to the Public Community of webMethods Developer Portal.
    4. Click Publish. The APIs along with their associated endpoints are published to webMethods Developer Portal and available for the consumers to consume. If you select several APIs, and one or more of them are REST-enabled SOAP APIs in webMethods API Gateway, then these SOAP APIs are published as REST APIs. They are published along with their specific REST endpoints in the Developer Portal.
    5. Examine the Publish APIs report window and check for any errors that occurred during the publishing process. The Publish APIs report window displays the following information.
      Parameter Description
      Name The name of the published API.
      Version The version of the published API.
      Status The status of the publishing process. The available values are
      • Success
      • Failure
      Description A descriptive information if the API publishing process fails or if a warning occurs.

      The results are recorded in the Audit Logs dashboard by webMethods API Gateway for later review.

    6. Click Download the detailed report to download the detailed report as an HTML file.

What to do next

  • You can unpublish a SOAP or REST API from webMethods Developer Portal to suspend its interaction, testing, and user consumption in webMethods Developer Portal. After you publish an API to webMethods Developer Portal, the API remains published and available on Developer Portal for consumption until you manually unpublish the API.

    After you unpublish, the API is no longer available on webMethods Developer Portal for testing and user consumption.

  • You can also bulk unpublish APIs from webMethods Developer Portal in a single operation from Setting icon drop down . After publishing API's, examine the Unpublish APIs report window and check for any errors that occurred during the unpublishing process. The Unpublish APIs report window displays the following information
    Parameter Description
    Name The name of the unpublished API.
    Status The status of the unpublishing process. The available values are
    • Success
    • Failure
    Description A descriptive information if the API unpublishing process fails or if a warning occurs.

    The results are recorded in the Audit Logs dashboard by webMethods API Gateway for later review.

  • Click Download the detailed report here to download the detailed report as an HTML file.