DataWorks allows you to create APIs by setting parameters in the codeless UI without the need to write code. This topic describes how to create an API in the codeless UI.

Prerequisites

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

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 and click DataService Studio in the Actions column.
  2. On the Service Development page, move the pointer over the Create icon and choose API > Generate API.
    You can also select a business process, right-click API, and then choose New > Generate API.
  3. In the Generate API dialog box, configure the parameters as required.
    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, such as /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 in the API Gateway console after the API is published to API Gateway. You must also upload a Secure Sockets Layer (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 Manage API tags.
    Note A tag can be up to 20 characters in length and can contain letters, digits, and underscores (_). You can set at most five tags for an API.
    Description The description of the API. The description can be up to 2,000 characters in length.
    Target 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. The default folder is in the format of Workflows/Business process name/API, such as Workflows/ceshi/API.
  4. Click OK.

Configure the API

  1. Double-click the API in the API list. On the tab that appears, set the Datasource Type, Datasource Name, and Table Name parameters in the Select Table section.
    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 table configuration tab automatically appears. Then, you can select a table for the API.
  2. In the Environment Configuration section, set the Memory and Function Timeout parameters.
    Environment Configuration section
  3. In the Select Parameters section, set the 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 that you want to add and click Add in the Add to field sort column to add the field to the Sort field section. Sort

    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 sorting. You can click Move up or Move down to adjust the sequence of a field. You can specify the sorting mode for each field by selecting Ascending order or Descending order in the Sort column.

  4. In the right-side navigation pane, click Request Parameters. In the Request Parameters pane, configure the parameters as required.
    Request parameters
    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 field that you want to bind to the request parameter. You cannot change the value.
    Parameter Type The 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 set the Content-Type parameter to define the format of the request parameters in the request body.
    Valid values of Content-Type:
    • 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 value that you specify.
    • >: The value of the request parameter is greater than the value that you specify.
    • <: The value of the request parameter is less than the value that you specify.
    • >=: The value of the request parameter is greater than or equal to the value that you specify.
    • <=: The value of the request parameter is less than or equal to the value that you specify.
    Note If you set the Datasource Type parameter to Table Store in the Select Table section, you set the Operator parameter only to =.
    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.
    To preprocess the request parameters of the API, select Use prefilter in the Advanced Settings section. For more information, see Use prefilters.
    Note
    • Only workspaces of DataWorks Professional Edition or a more advanced edition in the China (Shanghai) region support prefilters.
    • To improve the match efficiency, specify an indexed field as a request parameter.
    • To make sure that API callers understand the details about the API, we recommend that you specify information such as the example value, default value, and description for each parameter of the API.
  5. In the right-side navigation pane, click Response Parameters. In the Response Parameters pane, configure the parameters as required.
    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 field that you want to bind to the response parameter. You cannot change the value.
    Parameter Type The 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 and Filter in the Advanced Settings section.

    Select Pagination based on your needs.
    • 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 when you select Pagination:
    • Common request parameters
      • pageNum: the page number of 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.
    If you need to process the query results that are returned by the API, select Filter. For more information, see Use post filters.
    Note
    • Only workspaces of DataWorks Professional Edition or a more advanced edition in the China (Shanghai) region support post filters.
    • Request parameters are optional for an API. If you do not specify request parameters for an API, you must select Pagination.
  6. Configure an exclusive service resource group for DataService Studio.
    1. In the right-side navigation pane, click Resource Groups for DataService Studio. 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 shared resource group. DataWorks automatically assigns a shared resource group to generate the API.
      Note If you cannot select an exclusive resource group in the drop-down list, log on to the DataWorks console and bind the exclusive resource group to your workspace.
  7. Click the Save 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 Manage 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. On the Service Development page, click the business process to which the API that you want to manage belongs.
  2. Double-click the API. The configuration tab of the API appears.
  3. Click the Switch to the code editor icon in the toolbar.
  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.