DataWorks:Create an API by using the codeless UI

Go to the DataService Studio page

Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Development and Governance > DataService Studio. On the page that appears, select the desired workspace from the drop-down list and click Go to DataService Studio.

Create an API

1. In the Service Development pane, move the pointer over the icon and choose Create API > Generate API.

   You can also click a business process, right-click API, and then choose Create API > Generate API.

2. In the Generate API dialog box, configure the parameters.

   Parameter	Description
   API Mode	The mode used to create the API. Valid values: Wizard Mode and Script Mode. In this example, select Wizard Mode.
   API Name	The name of the API. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). The name must start with a letter.
   API Path	The path of the API. The path is the API request path that is relative to the service host address. Example: /user. Note The path can be up to 200 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The path must start with a forward slash (/).
   Protocol	The protocol used by the API. Valid values: HTTP and HTTPS. If you want to call the API by using HTTPS, you must bind an independent domain name to the API group to which the API belongs in the API Gateway console after the API is published to API Gateway. You must also upload an SSL certificate in the API Gateway console. For more information, see Enable HTTPS-based calls for APIs.
   Request Method	The request method. Valid values: GET and POST. Note If you select GET for the Request Method parameter, you can select only QUERY for the Position parameter. If you select POST for the Request Method parameter, you can select QUERY or BODY for the Position parameter.
   Response Type	The format of the data returned by the API. Set the value to JSON.
   Visible Scope	The range of users to whom the API is visible. Valid values: Workspace: The API is visible to all members in the current workspace. Private: The API is visible only to its owner, and permissions on the API cannot be granted to other members. Note If you set this parameter to Private, other members in the workspace cannot view the API in the API list.
   Label	Select tags from the Label drop-down list. For more information, see Create and manage API tags. Note A tag can be up to 20 characters in length and can contain letters, digits, and underscores (_). You can add up to five tags to an API.
   Description	The description of the API. The description can be up to 2,000 characters in length.
   Destination Folder	The folder in which you want to store the API. You can select a business process from the drop-down list. After you select a business process, a folder is generated under the business process and the API is stored in the folder. By default, the folder is in the format of Business Processes/Business process name/API, such as Business Processes/ceshi/API.

3. Click OK.

Configure the API

1. Double-click the API in the API list. On the tab that appears, configure the Datasource Type, Datasource Name, Data Source Environment, and Table Name parameters in the Select Table section.

   The parameters that you need to configure vary based on the selected data source type. The parameters in the console prevail.

   Note

   • Before you select a table for an API, you must configure a data source in Data Integration. You can enter a table name in the Table Name field to search for the table that you want to use.

   • For a workspace in standard mode, you can select Production or Environment for the Data Source Environment parameter. For more information, see Differences between workspaces in basic mode and workspaces in standard mode.

   • If you select a MaxCompute table for an API, you can select Acceleration Service or MCQA for the Acceleration Method parameter for acceleration. Acceleration Service is an acceleration method provided by DataWorks and MCQA is an acceleration method provided by MaxCompute. If you select Acceleration Service, you must make sure that acceleration items are created. For more information, see Acceleration solutions for API-based data queries.

   • After you create an API, the API configuration tab appears. Then, you can select a table for the API.

2. In the Select Parameters section, configure request and response parameters for the API.

   After you select a table in the Select Table section, all fields in the table appear in the Select Parameters section. In the Set as Req Param column, select the check boxes of the fields that you want to specify as request parameters. In the Set as Resp Param column, select the check boxes of the fields that you want to specify as response parameters.

   To sort the data that the API returns based on a specific field, find the field and click Add in the Add to field sort column. After you click Add, the field is added to the Sort field section.

   The sorting feature allows you to specify the fields based on which the data that the API returns is sorted. A field with a smaller sequence number in the Sort field section has a higher priority in data sorting. You can click Move up or Move down to adjust the sequence of a field. You can select Ascending order or Descending order in the Sort column of each field to specify the sorting mode.

3. In the right-side navigation pane, click the Request Param tab. On the Request Param tab, configure the parameters based on your business requirements.

   Note

   • Before you preview the result, you must configure information such as the example value, default value, and description for each request parameter of the API.

   • To improve the match efficiency, specify an indexed field as a request parameter.

   

   Parameter	Description
   Parameter Name	The name of the request parameter. The name can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
   Bound Field	The value cannot be changed. If you want to change the value, use the code editor to create an API. For more information, see Create an API by using the code editor.
   Type	The data type of the request parameter. Valid values: STRING, INT, LONG, FLOAT, DOUBLE, and BOOLEAN.
   Position	The position of the request parameter. Valid values: QUERY and BODY. Note If you set the Position parameter to BODY for one or more request parameters, you must configure the Content-Type parameter to define the format of the request parameters in the request body. Valid values of the Content-Type parameter: application/json;charset=utf-8: the JSON format. application/xml;charset=utf-8: the XML format. application/x-www-form-urlencoded;charset=utf-8: the FORM format.
   Operator	The operator that is used to associate or compare the value of the request parameter with the value that you specify. You can select one of the following operators: Equal: The value of the request parameter is equal to the specified value. LIKE: The value of the request parameter matches the specified pattern. IN: The value of the request parameter is in the specified range. NOT IN: The value of the request parameter is out of the specified range. NOT LIKE: The value of the request parameter does not match the specified pattern. !=: The value of the request parameter is not equal to the specified value. >: The value of the request parameter is greater than the specified value. <: The value of the request parameter is less than the specified value. >=: The value of the request parameter is greater than or equal to the specified value. <=: The value of the request parameter is less than or equal to the specified value. Note If you set the Datasource Type parameter to Tablestore in the Select Table section, you can set the Operator parameter only to Equal.
   Required	Specifies whether the request parameter is required. Valid values:
   Example Value	The example value of the request parameter.
   Default Value	The default value of the request parameter.
   Description	The description of the request parameter.

4. In the right-side navigation pane, click the Response Param tab. On the Response Param tab, configure the parameters.

   

   1. Configure the response parameters.

      Parameter	Description
      Parameter Name	The name of the response parameter. The name can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
      Bound Field	The value cannot be changed.
      Type	The data type of the request parameter. Valid values: STRING, INT, LONG, FLOAT, DOUBLE, and BOOLEAN.
      Example Value	The example value of the response parameter.
      Description	The description of the response parameter.

   2. Configure the Pagination for Return Results parameter.

      • If you do not turn on Pagination for Return Results, the API returns up to 2,000 records by default.

      • If more than 2,000 records may be returned, we recommend that you turn on Pagination for Return Results. If you turn on Pagination for Return Results, you can go to the Resource Group tab to configure the Maximum Number of Data Records for a Single Request parameter based on the resource group you selected.

      The following common parameters are available if you turn on Pagination for Return Results.

      • Common request parameters

        • pageNum: the number of the page to return.

        • pageSize: the number of entries to return on each page.

      • Common response parameters

        • pageNum: the page number of the returned page.

        • pageSize: the number of entries returned per page.

        • totalNum: the total number of returned entries.

      Note

      Request parameters are optional for an API. If you do not specify request parameters for an API, you must turn on Pagination for Return Results.

5. Configure a filter.

   If you need to preprocess the request parameters of an API or process the results returned by an API, you can perform the following steps to configure a filter for the API: In the right-side navigation pane, click the Filter tab. On the Filter tab, select Use Pre-filter or Use Post-filter based on your business requirements. After you configure the Function Type parameter, select one or more functions from the drop-down list next to the Use Pre-filter or Use Post-filter check box. If you select multiple functions, the functions are used to process parameters based on the sequence in which they are selected. Then, you can click Preview Responses Returned by API Operation and check whether the processing results of the selected functions meet your expectations. For more information about how to create and use a filter, see Create an Aviator function and Create a Python function.

   Note

   • If you want to use a Python function as a filter, you must activate DataWorks Professional Edition or a more advanced edition and use the shared resource group for DataService Studio.

   • If you want to use an Aviator function as a filter, all DataWorks editions are supported, but you must use an exclusive resource group for DataService Studio.

   • If the function that you want to use is not available in the drop-down list, check whether the function is published. If the function is not published, publish the function. You can also create and publish a function. For more information, see Publish a function.

   

6. Configure a resource group for DataService Studio.

   1. In the right-side navigation pane, click the Resource Group tab. In the Resource Group Type section, configure the Schema parameter.

      You can select Exclusive Resource Group for DataService Studio or Shared Resource Group for DataService Studio for the Scheme parameter. If you select Exclusive Resource Group for DataService Studio, select an exclusive resource group from the Exclusive Resource Group for DataService Studio drop-down list. If you select Shared Resource Group for DataService Studio, you do not need to select a resource group. DataWorks automatically uses the shared resource group to generate the API.

      Note

      If the exclusive resource group that you want to use is not displayed in the drop-down list, log on to the DataWorks console and associate the exclusive resource group with your workspace.

   2. In the Environment Configuration section, you can configure the Memory, Function Timeout, and Maximum Number of Data Records for a Single Request parameters.

      • The maximum value of the Function Timeout parameter varies based on the type of the resource group you select and the type of the API Gateway instance you use:

        • Shared API Gateway instances: The maximum value of this parameter is 30000.

        • Dedicated API Gateway instances: If you select Shared Resource Group for DataService Studio, the maximum value of this parameter is 30000. If you select Exclusive Resource Group for DataService Studio, the maximum value of this parameter is 90000.

      • The maximum value of the Maximum Number of Data Records for a Single Request parameter varies based on the type of the resource group you select:

        • If you select Shared Resource Group for DataService Studio, the maximum value of this parameter is 2000.

        • If you select Exclusive Resource Group for DataService Studio, the maximum value of this parameter is 10000.

7. Click the icon in the toolbar. After the API is saved, the selected resource group takes effect during the test.

   After the API is configured, you can test the API. For more information, see Test an API.

   After the test succeeds, click Submit in the upper-right corner.

   In the right-side navigation pane of the API configuration tab, click Version. Find the API version that you want to publish and click Application for publication in the Actions column to go to the application page. Use the default application type Publish data service API and enter the reason for the application in the Reason for application field. Then, click Apply for permission to submit the application.

   Note

   If you defined an approval policy in DataWorks Approval Center, the API must be approved before the API can be published. For more information, see Overview.

   After the API is published, the configuration of the resource group for DataService Studio takes effect when the API is called.

   On the Service Development tab, you can find the registered API in the left-side navigation pane and manage the API. For example, you can clone or delete the API. On the Service Management tab, you can find the published API and view the details of the published API. For more information, see View, delete, move, and clone an API, perform batch operations on multiple APIs, and use the code search feature to search for APIs.

Switch from the codeless UI to the code editor

On the configuration tab of an API, you can switch from the codeless UI to the code editor.

1. In the Service Development pane, click the business process to which the desired API belongs.

2. Find the API and double-click the API. The configuration tab of the API appears.

3. Click the icon in the top toolbar. Select Switch to Basic SQL or Switch to Advanced SQL based on your business requirements.

4. In the Note message, click OK.Then, you can view the SQL statements of the API in the Edit Query SQL section.

   Important

   • DataService Studio allows you to switch only from the codeless UI to the code editor.

   • After you switch from the codeless UI to the code editor, you cannot switch back to the codeless UI.