DataWorks allows you to use the codeless user interface (UI) to create APIs. When you use the codeless UI to create an API, you do not need to write code. You need to only configure the parameters. This topic describes how to use the codeless UI to create an API.

Prerequisites

A data source is configured on the Data Source page. For more information, see Configure a data source.

Background information

If you have personalized query requirements, you can use the code editor provided by DataWorks to create an API. When you use the code editor to create an API, you can customize SQL statements for the API. The code editor allows you to use table join queries, complex queries, and aggregate functions. For example, if you want to specify a request parameter to query data within a specific value range of a field, you can create an API in the code editor.

Create an API

  1. Go to the DataService Studio page.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. In the top navigation bar, select the region in which the workspace that you want to manage resides. Find the workspace, move the pointer over the More icon in the Actions column, and then select DataService Studio.
  2. In the Service Development pane, move the pointer over the Create icon and choose Create API > Generate API.
    You can also click a business process, right-click API, and then choose Create API > Generate API.
  3. In the Generate API dialog box, configure the parameters.
    Generate API dialog box
    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 for an API operation.

    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 Parameter Position parameter. If you select POST for the Request Method parameter, you can select QUERY or BODY for the Parameter Position parameter.
    Response Content Type The format of the data returned by the API. Set the value to JSON.
    Visible Range The range of users to whom the API is visible. Valid values:
    • Work Space: 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.
  4. Click Determine.

Configure the API

  1. Double-click the API in the API list. On the tab that appears, configure the Datasource Type, Datasource Name, 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. Select Table section
    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.
    • After you create an API, the API configuration tab appears. Then, you can select a table for the API.
  2. In the Environment Configuration section, configure the Memory and Function Timeout parameters.
    Environment Configuration section
    Note We recommend that you set the Function Timeout parameter to a value that is equal to or less than 10000 for a shared resource group and 30000 for an exclusive resource group for DataService Studio.
  3. 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. Select Parameters section
    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. 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.

  4. In the right-side navigation pane, click the Request Param tab. In the Request Param panel, 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.
    Request Param
    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 in the code editor.
    Parameter Type The data type of the request parameter. Valid values: STRING, INT, LONG, FLOAT, DOUBLE, and BOOLEAN.
    Parameter Position The position of the request parameter. Valid values: QUERY and BODY.
    Note If you set the Parameter 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 Table Store in the Select Table section, you can set the Operator parameter only to Equal.
    Required Specifies whether the request parameter is required.
    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.
  5. In the right-side navigation pane, click the Response Param tab. In the Response Param panel, configure the parameters.
    Response Param
    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.
    Parameter Type The data type of the response 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.

    You can select Pagination in the Advanced Settings section.

    Select Pagination based on your requirements, and take note of the following items:
    • If you do not select Pagination, the API returns up to 2,000 records.
    • If the API returns more than 2,000 records, we recommend that you select Pagination.
    The following common parameters are available if you select Pagination:
    • 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 select Pagination.
  6. Configure a filter.
    If you need to process 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 Filter. In the Filter panel, select Use Pre-filter or Use Post-filter based on your requirements. After you specify 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 use the Aviator function as a filter and Create and use Python functions as a filter.
    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 new function. For more information, see Publish a function.
    Filter
  7. Configure a resource group for DataService Studio.
    1. In the right-side navigation pane, click the Resource Group tab. 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 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.
      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.
  8. Click the Save icon 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 it. For more information, see Test an API.

    After the test succeeds, click Submission 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. You can use the default application type and enter the reason for the application. Then, submit the application.
    Note If you have defined an approval policy in DataWorks Approval Center, the API must be approved through the approval process 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 in the API list and view the details of the published API. For more information, see View, delete, move, and clone an API.

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 API belongs.
  2. Double-click the API. The configuration tab of the API appears.
  3. Click the API conversion script icon icon on the toolbar to commit the node.
  4. In the message that appears, click OK. Then, you can view the SQL statements of the API in the Edit query SQL section.
    Notice
    • 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.