Updated on 2024-05-07 GMT+08:00

Publishing an API

After creating an API, publish it in an environment so that it can be called by other users.

Constraints

  • If a published API is modified, you must publish it again for the modifications to take effect in the environment.
  • If the API has already been published in an environment, publishing it again will overwrite the existing one.

Prerequisites

RELEASE is the system default environment. To publish APIs in another environment, create an environment first.

Procedure

  1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
  2. In the navigation pane on the left, choose API Connect > APIs. Then choose Publish of an API.
  3. On the Publish APIs panel, configure publishing information and click OK.
    Table 1 Parameters for publishing an API

    Parameter

    Description

    Environment

    Select the environment to publish the API in. Or click Create Environment to create one.

    Description

    Enter the description of the API publication.

    After the API is published, click the API name and go to the APIs tab. Click More in the upper right corner and choose View Publishing Records for details. You can also view the API configuration of each released version and switch to a historical version.