DataWorks:Getting started

API development

DataService Studio provides three ways to create APIs:

Data Push

Data Push queries data sources on a schedule and pushes the results to messaging channels. Configure the push frequency, target channels, and recipient list to automate data delivery without writing pipeline code. For details, see Data Push.

Prerequisites

Before you begin, ensure that you have:

• An active DataWorks workspace

• API Gateway activated

• A MySQL data source configured in DataWorks. This tutorial uses a source named rds_workshop_log. For setup, see Configure a data source.

• A Serverless resource group with a DataService Studio quota configured. See Configure a quota for DataService Studio in a Serverless resource group.

Step 1: Create a data source and configure network connectivity

DataService Studio uses the data source to retrieve table schema during API configuration and to run queries when the API is called.

1. Go to DataWorks Management Center, select your workspace, and click Go to Management Center.

2. In the left navigation pane, click Data Source.

3. Click Add Data Source and select MySQL.

4. Configure the connection parameters. For field descriptions, see Configure a MySQL data source.

5. Select your Serverless resource group and run the connectivity test.

   - If you have high-concurrency tasks that cannot be run during off-peak hours, use dedicated resources to support high-concurrency and high-frequency API calls. We recommend that you purchase and use a Serverless resource group from DataWorks. - When using a Serverless resource group, configure a DataService Studio quota before running API calls. - If the connectivity test fails, see Network connections and whitelists.

6. Click Complete to save the data source.

Step 2: Create an API group

API Gateway organizes APIs into groups. Each group is associated with a domain name used to construct the API call address. Create an API group before creating APIs in DataService Studio.

1. Go to the API Gateway console and open the Group Management page.

2. Click Create Group, fill in the group details, and confirm. This tutorial uses a group named Workshop.

Step 3: Create a business process

A business process organizes related APIs and functions into a single unit. APIs must belong to a business process.

1. Log on to the DataWorks console. In the top navigation bar, select your region, then choose Data Analysis and Service > DataService Studio. Select your workspace and click Go to DataService Studio.

2. On the Service Development page, create a business process using either method:

   • Click the icon and select Create Business Process.

   • Right-click the Business Process folder in the left navigation pane and select Create Business Process.

3. Configure the business process:

   Parameter	Description
   Business Name	A name for this business process. This tutorial uses DataService.
   API Group	The API group that manages APIs in this business process. Select the Workshop group created in Step 2. An API group is the smallest management unit in API Gateway — it maps a set of APIs to a domain name.

4. Click OK.

Step 4: Generate an API

With a business process in place, generate an API from the MySQL table.

1. On the Service Development page, start the API creation using either method:

   • Click the icon and choose Create API > Generate API.

   • Right-click the business process in the left navigation pane and choose New > API > Generate API.

2. In the Generate API dialog box, configure the API properties:

   Parameter	Description
   Destination Folder	The folder within the business process where the API is stored. Select a folder, or create a business process first if no folder is available.
   API Mode	Codeless UI — configure without code. Code editor — write custom SQL for advanced queries (table joins, aggregate functions). This tutorial uses the codeless UI.
   API Name	A name for the API. This tutorial uses rpt_user_info_all_d.
   API Path	The URI path appended to the service host to form the call address. This tutorial uses /user.
   Protocol	HTTP or HTTPS. To use HTTPS, bind an independent domain name and upload an SSL certificate in the API Gateway console after publishing. See Support for HTTPS.
   Request Method	GET or POST. With GET, Parameter Position for request parameters must be QUERY. With POST, Parameter Position can be QUERY or BODY.
   Response Type	JSON (only supported format).
   Visible Scope	Workspace — visible to all workspace members, authorization supported. Private — visible only to the API owner, authorization not supported. This tutorial uses Workspace.

   

3. Configure the data source and parameters on the API editing page: In Select Table, choose the data source: In Select Parameters, select the table fields to use as request and response parameters. Add fields to Sort Fields to control sort order. This tutorial uses uid as the request parameter and all table fields as response parameters.

   Click Request Parameters or Response Parameters in the right navigation pane to edit field type, sample value, and default value.

   Parameter	Description
   Data Source Type	The database type. This tutorial uses MySQL.
   Data Source Name	The data source configured in Step 1. This tutorial uses rds_workshop_log.
   Data Source Environment	In standard mode workspaces, choose between the development and production environment. See Comparison of basic mode and standard mode. This tutorial uses Production Environment.
   Data Table Name	The table to generate the API from. This tutorial uses rpt_user_info_all_d in the rds_workshop_log data source.

   

4. Configure the resource group: click Service Resource Group on the right side of the API editing page. Select a Serverless resource group with a configured DataService Studio quota (recommended) or an exclusive resource group for DataService Studio.

Step 5: Test the API

Test the API to verify the request and response before publishing.

Click Test in the upper-right corner of the API editing page. Set the uid request parameter to 0016359810821 and run the test. Confirm the response matches the expected data.

For details, see Test an API.

Step 6: Publish the API

After the API passes testing, publish it to API Gateway so other services can call it.

Click Submit in the upper-right corner of the API editing page and select the version to publish. After publishing, the API is available in API Gateway. You can also list the API on Alibaba Cloud API Marketplace to sell it.

For details, see Publish an API.

Step 7: Call the API

DataService Studio supports two authentication methods for API calls:

• Simple Authentication: Lower security. Suited for internal dashboards and reports.

• Encrypted Signature Authentication: Higher security. Suited for application development.

To call the API:

1. In the DataService Studio top menu bar, click Service Management.

2. In the left navigation pane, select API Invocation.

Published APIs are hosted in API Gateway and callable using an API Gateway SDK. For code samples, see Examples of calling an API from a client.

Step 8: View and manage the API

After publishing, manage your APIs from the Service Management page.