This topic describes how to go to the details page of an API and view the details about the API, such as the basic information, parameter information, and sample response.
Go to the details page of an API
- Log on to the DataWorks console. Then, go to the DataMap page. For more information, see Go to the homepage of DataMap.
- In the top navigation bar, click All Data.
- Click the API tab above the search box. Then, find the API whose details you want to view and click its name.
View the details of an API
The API details page displays the following information of the API: Basic Information, Technical Information, Parameter Information, Sample Response, and Usage Notes.
|In this section, you can click Edit API to go to the editing page of the workspace to which the API belongs and edit the
API. For more information, see Publish an API and Register an API.
Note You must make sure that the Alibaba Cloud account that you use to log on to the DataWorks console is a member of the workspace to which the API belongs and the development engineer role is assigned to the member. Otherwise, contact the workspace administrator. For more information, see Manage workspace-level roles and members.
|In this section, you can search for an API by keyword such as API ID, API path, API name, or API description.
|In this section, you can view the following information of the API:
|In this section, you can view the information of the API on the following tabs: