DataService Studio lets you write functions and associate them with APIs. These functions can act as filters to process API request parameters or returned results. This topic describes this feature.
Limits
To use the filter feature, you must purchase DataWorks Basic Edition or a later version.
Python functions are being upgraded. You cannot create, clone, or publish new Python functions. To use a function as an API filter, use the Aviator function type. For more information, see Create an Aviator function.
Notes
The pre-filter and post-filter for an API must be of the same function type: either both Aviator or both Python. Using different function types for the pre-filter and post-filter of the same API is not supported.
For security and performance reasons, Aviator functions must run in an exclusive resource group for DataService Studio.
When you edit or test a function, you must attach an exclusive resource group for DataService Studio to it. For more information, see Create a function.
During API development, if you enable a filter and associate a target function, you must attach an exclusive resource group for DataService Studio to the API. For more information, see Generate an API in the codeless UI.
Function introduction
DataService Studio supports Aviator and Python functions. You can use DataService Studio to create functions, test, publish, and use functions, and publish functions. After a function is published, you can associate it with an API and use it as a filter to process the API's request parameters or returned results. This helps you meet complex query requirements and adapt to various business scenarios. For more information, see Use a function as an API filter.
A pre-filter can preprocess an API's request parameters when the API is called.
A post-filter can reprocess and transform an API's returned results when the API is called.
For code examples of common scenarios, see Best practices: Use an Aviator function as a filter.