Dataphin:Test and publish API

Prerequisites

Ensure that you have created the API before starting the operation. For more information, see Create API.

Operations at the top area of the API test page

• View Domain Name: The domain name displayed at the top of the page is for internal testing purposes only. To view the domain name intended for client calls, refer to View domain name.

• Switch API: In the upper left corner of the page, you can switch between submitted and published APIs. Utilize the fuzzy search feature based on the API name or ID to access APIs within the current service project. The system will suggest the last nine APIs you've interacted with in the project.

• Switch API Runtime Environment: Change the API runtime environment for testing purposes. Use the development data source when in the development environment and the production data source when in the production environment. If the API is not published, it cannot be tested in the production environment.

  Note

  Note: If the API is in Basic mode and the runtime environment is set to development, the production data source will be used for testing.

• Switch API Version: In the upper right corner of the test page, you can switch between API versions for testing. Select the submitted version in the development environment and the published version in the production environment.

Step 1: Test the API

1. Navigate to Service > Development from the top menu bar of the Dataphin home page.

2. Select the service project in the upper left corner and choose API Service > API from the left-side navigation pane to access the API page.

   • On the API page, click the Test icon in the Actions column of the target API to enter the API test page.

   • Click More-Version Management in the Actions column of the target API to access the Version Management panel. Then click Test in the operation column of the target API to enter the API test page.

3. On the API Test page, input parameter values to verify if the returned parameters meet expectations.

   1. Configure the Test Input Value in the Business Request Parameter List as the field value in the business data.

      The parameters in the Business Request Parameter List are those you configured when creating the API.

   2. Set the parameters in the Public Request Parameter List.

      Parameters found in the Public Request Parameter List include PageStart, PageSize, and OrderByList, which may differ based on the API request method.

      • Enable paged query. For LIST request methods, PageStart, PageSize, and OrderByList parameters are displayed. For GET requests, only the OrderByList parameter appears.

      • Disable paged query. For LIST request methods, only the OrderByList parameter is shown. You can unhide Hidden Parameters to display PageSize and OrderByList. For GET requests, OrderByList is displayed.

        Parameter	Description	Debug Input Value
        apiVersion	Specifies the version of the API to be called. By default, the latest version is used.	The debug input value is obtained by switching versions at the top right of the page. Note In the development environment, the apiVersion parameter is supported. Only submitted APIs can be selected for calling.
        PageStart	Defines the starting point of the returned data.	Set as a positive integer, such as 2.
        PageSize	Defines the number of data entries returned per page.	Set as a positive integer, such as 56.
        OrderByList	Defines the sorting method for multiple return parameters. If not specified, the default is ascending order.	The debug input value must be obtained from the Business Request Parameter List.

   3. Choose at least one return parameter from the Optional Return Parameter List section. This list matches the API's return parameters for the chosen version. Selecting a return parameter is necessary to test the API.

   4. Set the API protocol and return count.

      Parameter	Description
      Protocol	If you selected the HTTP and HTTPS protocols when creating the API, you can select the protocol when debugging the API.
      Return Count	Used to define the number of data returned when testing the API: If the request method is LIST, you can select Return Count. A maximum of 10,000 data entries can be returned. If the request method is GET, modifying Return Count is not supported.

4. After configuration, click Debug/Test to test the API's connectivity with the data source.

   During the test, you can view the SQL script by clicking View Script to ensure the query results align with the script's expectations. If the registered API does not have an SQL script, this option is not available.

5. Examine the test results in the Return Result/Test Details area.

   If the test fails, you can view Appendix: Error Codes and Solutions.

6. To authorize the API for the application, click the API Authorization button located at the bottom. For more information, see Data Service Permission Management.

Step 2: Publish the API

Business application users can subsequently query and request call permissions for the API on the DataService Studio overview page.

Appendix: Error codes and solutions