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 connection is configured on the Data Source page. For more information, see Configure a connection.

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 where the target workspace resides. Find the target workspace and click DataService Studio in the Actions column.
  2. On the Service Development tab, move the pointer over Create icon and choose API > Generate API.
    You can also click the target business process, right-click API, and then choose New > Generate API.
  3. In the Generate API dialog box, set the parameters as required.
    Generate API dialog box
    Parameter Description
    API mode The mode for creating 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 (_). It must start with a letter.
    API Path The path for storing the API, such as /user.
    Note The path can be up to 200 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a forward slash (/).
    Protocol The protocol used by the API. Valid values: HTTP and HTTPS.

    If you need 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. In addition, you must 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 used by the API. Valid values: GET and POST.
    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 users.
      Note If you set this parameter to Private, other members in the workspace cannot view the API in the API list.
    Label The tags to be attached to the API. 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, which can be up to 2,000 characters in length.
    Target Folder The folder for storing the 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 connection in Data Integration. You can enter a table name in the Table Name field to search for the desired table.
    • After you create an API, the table configuration tab automatically appears for you to 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. Select the required fields and select the check boxes in the Set as Req Param and Set as Resp Param columns as required.Select Parameters section
    To sort the data returned by the API based on a field, click Add to field sort in the Field sorting column of the field to add it to the Sort field section.Field sorting column

    The sorting feature allows you to specify the fields based on which the data returned by the API 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, set the parameters as required.
    Request Parameters pane
    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 (-). It must start with a letter.
    Bound Field The field to be bound 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.
    Operator The operator that is used to associate or compare the value of the request parameter with the specified value. 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.
    Required Specifies whether the request parameter is required.
    Example Value The sample 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
    • Prefilters are supported only in the China (Shanghai) region for DataWorks Professional Edition or more advanced editions.
    • To enhance the matching efficiency, set an indexed field as a request parameter.
    • To make it easier for API callers to know the details about the API, we recommend that you specify information such as the sample 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, set the parameters as required.
    Response Parameters pane
    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 (-). It must start with a letter.
    Bound Field The field to be bound 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 sample 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 a maximum of 2,000 records by default.
    • If the API may return 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 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.
    If you need to process the query results returned by the API, select Filter. For more information, see Use post filters.
    Note
    • Post filters are supported only in the China (Shanghai) region for DataWorks Professional Edition or more advanced editions.
    • Request parameters are optional for an API. If you do not specify any request parameters for an API, you must select Pagination.
  6. Click Save icon in the toolbar.
    After the API is configured, you can test it. For more information, see Test an API.

    After the API is tested, close the Test APIs dialog box, and click Publish in the upper-right corner of the configuration tab.

    On the Service Development tab, you can double-click the published API to view the details of the API and clone or delete the 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. On the Service Development tab, click the business process to which the target API belongs.
  2. Double-click the target API. The configuration tab of the API appears.
  3. Click API conversion script 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.