Help Center/ API Gateway/ User Guide/ Opening APIs/ Publishing an API
Updated on 2024-11-27 GMT+08:00
View PDF
Share

Publishing an API

APIs can be called only after they have been published in an environment. You can publish APIs in different environments. APIG allows you to view the publication history (such as the version, description, time, and environment) of each API, and supports rollback of APIs to different historical versions.

  • If you modify a published API, you must publish it again for the modifications to take effect in the environment in which the API has been published.
  • A maximum of 10 publication records of an API are retained in an environment.

Prerequisites

You have created an environment.

Publishing an API

  1. Go to the APIG console.
  2. Select a dedicated gateway at the top of the navigation pane.
  1. Choose API Management > API Groups.
  2. Click a group name.
  3. On the APIs tab, select the target API and click Publish Latest Version.
  4. Select the environment where the API will be published, and enter a description.

    • If the API has already been published in the environment, publishing it again will overwrite its definition in that environment.
    • If there is no environment that meets your requirements, create a new one.

  5. Click OK. After the API is published, the red exclamation mark (!) in the upper left corner of the Publish Latest Version button disappears.

    You can remove APIs from the environments where they have been published. This operation will cause the APIs to be inaccessible in the environments. Ensure that you have notified users before this operation. To remove an API, click Take Offline.

Viewing Publication History

  1. On the APIs tab, select the target API.
  2. Choose More > View Publishing Records.
  3. Click View Details in the Operation column of a version.

    The View Details dialog box displays the basic information, frontend and backend request information, input and constant parameters, parameter mappings, and example responses of the API.

  4. To roll back the API to a historical version, click Switch Version in the row containing the target version, and click Yes.

    If "current version" is displayed next to the target version, the rollback was successful.

    When the API is called, configuration of the current version is used instead of the previously saved configuration.

    For example, an API was published in the RELEASE environment on August 1, 2018. On August 20, 2018, the API was published in the same environment after modification. If the version published on August 1 is set as the current version, configuration of this version will be used when the API is called.

FAQs About API Publishing

Do I Need to Publish an API Again After Modification?

Why Can't APIs Published in a Non-RELEASE Environment Be Accessed?

Can I Invoke Different Backend Services by Publishing an API in Different Environments?

Follow-Up Operations

After the API is published, you or the API caller can call the API. If you provide an API that is accessed through App authentication, perform the operations described in (Optional) Configuring Authorization for API Calling before calling the API.

Parent topic: Opening APIs