DataWorks:DataService Studio

Function introduction

DataService Studio uses a serverless architecture. This lets you focus on the query logic of your API without managing the underlying infrastructure, such as the runtime environment. DataService Studio prepares computing resources for you, supports scalability, and requires zero operations and maintenance (O&M) costs.

Related concepts

• Application programming interface (API): An API is an interface that allows applications, software, and systems to interact with data sources. DataService Studio APIs support read data operations to continuously query data from databases and data tables.

• Function: A function acts as an API filter to process the request or response parameters of an API. When you use a function as an API filter, the function types for the pre-filter and post-filter must be the same.

• Exclusive resource group for DataService Studio: If calling DataService Studio APIs requires a high number of queries per second (QPS) and Service-Level Agreement (SLA) assurance, you can use an exclusive resource group for DataService Studio to ensure successful calls. An exclusive resource group for DataService Studio can handle high-concurrency and high-frequency API calls and promptly return results.

Billing

API development flow

1. Create a data source and configure network connectivity

   Before you create an API in DataService Studio, you must add your database or data warehouse as a DataWorks data source. This source provides the data for the DataService Studio API. When you develop a DataService Studio API, DataService Studio accesses this data source to retrieve the schema information of the data table. This helps you configure request and response parameters. When you call the DataService Studio API, DataService Studio accesses this data source to execute the query. For a list of data sources supported by DataService Studio, see List of data sources for DataService Studio.

   Important

   If the connectivity test fails, check the configuration by following the instructions in Network connectivity and whitelist configuration.

2. Create a business flow

   DataService Studio uses business flows to develop data service APIs based on business units. Business flows also organize and manage APIs and related files, such as the functions that are used to create the APIs. Therefore, before you create an API in DataService Studio, you must create a business flow.

3. Create an API

   • Generate a data API from a data table

     • DataService Studio provides a Codeless UI with visual configurations that you can use to generate data APIs from data tables in various data sources. This lets you configure an API without any coding skills. For more information, see Generate an API in the codeless UI.

     • To meet the custom query needs of advanced users, DataService Studio provides a Code Editor for custom SQL. You can write your own SQL queries for the API. The code editor supports features such as table joins, complex queries, and aggregate functions. For more information, see Generate an API in the code editor.

   • Register an existing API to the platform for unified management and publishing. For more information, see Register an API.

4. Create a function (filter)

   This is an optional step. You can use Function Compute to process the request parameters and response results of an API.

5. Test an API

   After an API is created, you must test it. The API can be published online only after it passes the test.

6. Publish an API

   An API that passes the test can be published to API Gateway. After the API is published, other services can call it. You can also list a published API for sale on the Alibaba Cloud API Marketplace with a single click. This helps enterprises quickly monetize their data and complete the business cycle.

   Note

   • API Gateway provides a hosted service for APIs. It covers the full lifecycle management of APIs, including publishing, management, O&M, and sales. It helps you implement microservice aggregation, frontend-backend separation, and system integration in a simple and quick manner with low costs and risks. It also helps you expose features and data to partners and developers. For more information, see Product Introduction.

     API Gateway is the last line of defense for APIs that are exposed externally or called within your own applications. It provides services such as permission management, traffic shaping, access control, and metering. APIs that are generated and registered in DataService Studio must be published to API Gateway before they can serve external requests. DataService Studio is integrated with API Gateway and supports one-click publishing of APIs to API Gateway.

   • The Alibaba Cloud API Marketplace covers seven major categories: finance, artificial intelligence, e-commerce, transportation and geography, lifestyle services, enterprise management, and public affairs. Thousands of API products are for sale on the platform, which helps you quickly monetize your data.

7. Call an API

   An application (APP) serves as your identity when you call an API service. When you use an APP to call an API, the APP must be granted authorization for that API. You can obtain authorization to use APIs from others, or grant authorization for your APIs to others to enable data sharing. For more information, see Grant authorization for an API. You can use API Gateway to call API services from other Alibaba Cloud users or third-party service providers. API Gateway provides a range of management services and support.