This topic describes how to manage APIs in the API Gateway console.
1. Edit an API
You can view and edit the API definition as needed.
Procedure:
Log on to the API Gateway console.
In the navigation pane on the left, click .
Find the API that you want to edit and click
> Manage in the Actions column. The API definition page appears. You can edit the definition as needed and then click the Edit button.
The process for editing an API definition is the same as the process for creating one. For more information, see Create an API. To discard the edits, click Cancel Edit at the top of the page.
After you edit an API, you must publish it to the test, pre-release, or production environment before the new version can be called.
If you edit a published API, the changes do not affect the production environment. You must publish the API again to sync the changes to the production environment.
2. Compare differences
After you edit an API, you can use the Compare differences feature to compare its new configuration with the previously published version. This helps you verify that the scope of your changes is correct.
Procedure:
After you finish editing the API, click the Save button. On the confirmation page that appears, click the Publish button.
On the publish API page, select an environment to publish to. Then, click Compare differences to compare the configuration with the previously published version. After you confirm the changes, publish the API.
3. Query the release history and switch versions
API Gateway records each time an API is published to an environment. The release history includes the version number, environment, publication time, and any release notes that you entered. You can view any record in the release history.
3.1 Query the release history
Log on to the API Gateway console. In the navigation pane on the left, click . Find the API and click its name.
In the navigation pane on the left, click Release History to view the API's release history. In the Actions column for a specific version, click View to view the API Definition Details.
3.2 Switch to this version
When you view the release history, you can select a version and click Switch to this version. This action immediately replaces the current version in the specified environment with the selected one.
Select the desired version and click Switch to this version in the Actions column.
In the API Version Switch confirmation dialog box, enter remarks and click Switch.