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

  1. Log on to the DataWorks console. Then, go to the DataMap page. For more information, see Go to the homepage.
  2. In the top navigation bar, click All Data.
  3. 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. API Details page
Section Description
1 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 members and roles.
2 In this section, you can search for an API by keyword such as API ID, API path, API name, or API description.
3 In this section, you can view the following information of the API:
  • Basic Information: You can view the information such as Views, Calls, API ID, Workspace, Owner, Created At, Updated At, and Description.
  • Technical Information: You can view the information such as API Type, Request Method, Response Type, Data Source Type, Data Source Name, and Table Name.
4 In this section, you can view the information of the API on the following tabs:
  • Parameter Information: This tab contains the Request Parameters and Response Parameters subtabs.
    • Request Parameters: This subtab contains the Common Request Parameters and API Request Parameters sections. In these two sections, you can view the following information: Parameter Name, Parameter Type, Parameter Position, Sample Value, Default Value, Description, and Tag.
    • Response Parameters: This subtab contains the Common Response Parameters and API Response Parameters sections. In these two sections, you can view the following information: Parameter Name, Parameter Type, Sample Value, and Description.
  • Sample Response: You can view the data and data structure in the sample response of the API on this tab. If you test the API before you publish it and select Save the correct response example automatically, the sample response of the API on this tab is updated. For more information about how to test an API, see Test an API.
  • Lineage: You can view the lineages among the data table, API, and application on this tab. You can use the following types of data sources as the upstream lineages of DataService Studio APIs: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0, and AnalyticDB for PostgreSQL.
    Note
    • You can use the Generate API method to generate APIs that are encapsulated by using data sources or tables. The lineage link of an API that is generated by using this method contains a data table, the API, and an application.
    • You can use the Register API method to generate APIs that are encapsulated by using backend addresses. The lineage link of an API that is generated by using this method contains the API and an application.
    • The lineage of an API is generated one day after the API is created and published. The lineage of an API is updated one day after the API is last modified and published.
  • On the Usage Notes tab, you can edit usage notes, view the historical versions of the usage notes, and view the business description of data.