How to view and manage APIs - Dataphin - Alibaba Cloud Documentation Center

After creating an API, you can manage API versions and change API owners. This topic describes how to manage APIs.

Permission description

Super administrators can manage all APIs.
Project administrators can manage APIs in the projects they own.
API owners can manage the APIs they own.

API list entry

In the top navigation bar of the Dataphin homepage, choose Service > API Development.
In the upper-left corner, select a service project. Then, in the left-side navigation pane, choose API Service > API to go to the API list page.
You can search for a target API by API name or ID. You can also quickly filter APIs Submitted Today, My APIs, or filter target APIs by API type, data source, API group, last submission time, pattern, invocation mode, current status, or owner.
My APIs: APIs that you own. This does not include APIs for which you have requested permissions.
The API list displays the created APIs, including API name and ID, API type, data source, invocation mode, pattern (environment), current status, runtime environment, published version, publication information, data update frequency, API group, owner, number of applications associated with the API, permission information, and other API details.

You can perform the following operations in the operation column of a target API.

Operation	Description
Publish	Click Publish in the operation column or select the APIs to be published and click Batch Publish at the bottom. In the API Publication dialog box, select the submitted version to be published to publish the API to the production environment. For more information, see Step 2: Publish an API. Note If a version is already published online, parameters are verified when a new version is published online. The verification includes adding required request parameters, removing request parameters, removing response parameters, changing the data type of request parameters, and changing the invocation type. Publishing a new version online affects API invocation. You can configure different publication control mechanisms in a project. When an API is published, the system blocks or publishes the API based on the configuration of the project to which the API belongs. For more information, see Create service projects. APIs created based on logical tables do not support batch publishing. During batch publishing, if no version is selected, the API is not published.
Edit	Click the Edit icon in the operation column to go to the Edit API page. Note The system enters the edit page of the latest API version by default. If you need to modify another version of the API, you can switch the API version in the upper-right corner of the edit page to edit different versions. When the API version is in the submitted or draft state, you can switch to view APIs in the upper-left corner of the page. You can search for APIs by name or ID using fuzzy search to switch between APIs that you have permissions to access in the current service project. The system recommends the last nine APIs that you have accessed (including view, edit, test, and add) in the current project. If the latest version of the API is in the published state, editing is not supported. The system automatically creates a new version based on the latest published version and automatically fills in the version number. After you confirm that the version and version number are correct, click OK to go to the Add API Version page. When the API version is in the submitted or draft state, you can directly go to the API edit page.
Test	Click the Test icon in the operation column to go to the Developer > API > API Test page. The system automatically enters the latest testable version of the current API for testing (the version is in the submitted or published state). Note In the test environment, multiple API versions can coexist and be tested. Based on the test results of different API invocations, you can publish the version with better feedback to online applications. For more information about the operations, see Step 1: Test an API.
Version Management	Click the More icon in the operation column and select Version Management. In the Version Management panel, you can edit, test, compare versions, delete, and clone different versions of the API. Note If downstream applications cannot modify the API_ID when invoking the API, and the data source or query conditions of the API change, you can develop and test multiple versions, and then publish the new version to the production environment to overwrite the original version. This avoids adjustments on the downstream application side. For more information about the configuration, see API multi-version management.
Modify API properties	Click the More icon in the operation column and select Modify API properties. In the Modify API properties dialog box, you can modify the API name, API group. The naming conventions for the name are the same as those for creating a new API.
Change Owner	Click the More icon in the operation column and select Change Owner. In the Change Owner dialog box, select User Account. You can transfer the API to another developer or project administrator in the project. Click OK to change the owner.
Clone API	Click the More icon in the operation column and select Clone API. In the Clone API dialog box, select the version to be cloned and click OK to go to the Create API page where you can modify more information. Note Cloning an API clones all information of the selected version of the API and creates a new API. Because API names must be unique within a project, modify the name of the new API to avoid submission failures. The system selects the latest submitted (including published) version by default. You can clone any version of the current API regardless of its state.
Delete	Click the More icon in the operation column and select Delete. If the API has no dependencies, click OK in the API Delete dialog box to delete it. If the API permissions have been granted to applications or the API is referenced by a composite API, you must revoke the permissions granted to applications or remove the reference from the composite API before you can delete the API.

API multi-version management

Add an API version

On the API list page, click Version Management in the operation column to go to the Version Management panel.

In the Version Management panel, click Add Version and configure the parameters.

Parameter	Description
Based On Existing Version	The most recent version is filled in by default. You can select any version of the current API regardless of its state.
Version Number	The system fills in the version number by default, which you can modify. Each API has a unique version number to facilitate comparison with the previous version. The version number is limited to 64 characters and must be unique for the API.

Click OK to go to the Add API Version page and configure the parameters.
After you confirm that the information is correct, click Submit to complete the creation of the new API version. You can manage the API on the API list page.

Manage API versions

Area	Description
①API name	Displays the name of the current API.
②List area	Displays the version number, version status, creator, and update time.
③Operation area	Different operations are supported for versions in different states. Draft state: View details, edit, clone API, and delete. Published state (version currently in use online): View details, test, compare versions, and clone API. Published state (historical published version): View details, test, compare versions, clone API, and delete. Submitted state: View details, test, edit, compare versions, clone API, and delete. The operations are described as follows: View Details: Click View in the operation column to view the API configuration details. You can switch versions in the upper-right corner of the page to view the configuration details of the API. You can switch to view APIs in the upper-left corner of the page. You can search for APIs by name or ID using fuzzy search to switch between APIs that you have permissions to access in the current service project. The system recommends the last nine APIs that you have accessed (including view, edit, test, and add) in the current project. You can click the Edit API or Test API button at the bottom to quickly edit or test the API. When the API is in the draft state, the Test API operation is not supported. When the API type is direct connection data source API and row-level permissions are enabled, row-level permission information is displayed. You can switch to view the row-level permission information associated with the API under the corresponding environment and version. Test: Click Test in the operation column to go to the Developer > API > API Test page. The system enters the API test page of the current version by default and automatically enters the latest testable version of the current API for testing (the version is in the submitted or published state). You can switch versions in the upper-right corner of the page for testing. You can switch to view submitted or published APIs in the upper-left corner of the page. You can search for APIs by name or ID using fuzzy search to switch between APIs that you have permissions to access in the current service project. The system recommends the last nine APIs that you have accessed (including view, edit, test, and add) in the current project. In the test environment, multiple APIs can coexist and be tested. Based on the test results of different API invocations, you can publish the version with better feedback to online applications. For more information about the operations, see Step 1: Test an API. Version Comparison: Click Version Comparison in the operation column to switch and view the differences between two versions. Note Only submitted and published versions can be compared. When there is only one submitted or published version, version comparison is not supported. Draft versions cannot be compared. Direct connection data source APIs, SQL mode APIs (service units and logical tables), and composite APIs support script comparison, which makes it convenient for developers to view and compare script content. When the API uses asynchronous invocation, cache settings, cache duration, and result paging information are not displayed. When the API type is direct connection data source API and row-level permissions are enabled, row-level permission list comparison information is displayed. You can switch to view the row-level permission information associated with the API under the corresponding version. Clone API: Click More-Clone API in the operation column. In the Clone API dialog box, select the version to be cloned and click OK to go to the Create API page where you can modify more information. Note Cloning an API clones all information of the selected version of the API and creates a new API. Because API names must be unique within a project, modify the name of the new API to avoid submission failures. The system selects the latest submitted (including published) version by default. You can clone any version of the current API regardless of its state. Edit: Click Edit in the operation column to go to the Edit API page. Note The system enters the edit page of the latest API version by default. If you need to modify another version of the API, you can switch the API version in the upper-right corner of the edit page to edit different versions. When the API version is in the submitted or draft state, you can switch to view APIs in the upper-left corner of the page. You can search for APIs by name or ID using fuzzy search to switch between APIs that you have permissions to access in the current service project. The system recommends the last nine APIs that you have accessed (including view, edit, test, and add) in the current project. If the latest version of the API is in the published state, editing is not supported. The system automatically creates a new version based on the latest published version and automatically fills in the version number. After you confirm that the version and version number are correct, click OK to go to the Add API Version page. When the API version is in the submitted or draft state, you can directly go to the API edit page. Delete: Click More-Delete in the operation column. If the API has no dependencies, click OK in the API Delete dialog box to delete it. If the API permissions have been granted to applications or the API is referenced by a composite API, you must revoke the permissions granted to applications or remove the reference from the composite API before you can delete the API.