Test a function to verify its behavior, publish it to make it available, and attach it to an API as a pre-filter or post-filter.
Prerequisites
Before you begin, make sure that you have:
-
A function that is created and saved. See Manage functions.
-
One of the following roles in the workspace: workspace owner, Workspace Administrator, Develop, or O&M. See the "Add a RAM user to a workspace as a member and assign roles to the member" section in Manage permissions on workspace-level services.
Step 1: Test the function
-
Go to the DataService Studio page. Log on to the DataWorks console. In the top navigation bar, select the region. In the left-side navigation pane, choose Data Analysis and Service > DataService Studio. Select the workspace from the drop-down list and click Go to DataService Studio.
-
In the left-side navigation pane of the Service Development page, find and double-click the function.
-
On the configuration tab of the function, click Test in the upper-right corner.
-
In the Function Test dialog box, specify the input parameters and click OK. The Execution results tab at the bottom of the page shows the running status and output of the test. If the test fails, check the error message, update the function, and run the test again.
Step 2: Publish the function
After you test a function, you can publish the function.
-
In the left-side navigation pane of Service Development, find and double-click the function you tested.
-
On the configuration tab, click Submit in the top toolbar.
-
In the right-side navigation pane, click Version. Find the version in the Can Be Published state and click Publish in the Actions column.
After publishing, click Version in the right-side navigation pane to view the publishing history. In the Actions column, you can click Version Details to view version information or click Roll Back to revert to a previous version.
Step 3: Use the function as a filter for an API
A function can intercept and transform data flowing through an API:
-
Pre-filter: Preprocesses the request parameters before the API executes.
-
Post-filter: Processes and reconstructs the API response after the API executes.
Limitations
-
If you attach both a pre-filter and a post-filter to the same API, all filters must be the same function type — either all Aviator functions or all Python functions. You cannot mix function types on a single API.
-
The Python function filter feature is currently being optimized. Creating, cloning, or publishing new Python functions is not supported.
Attach a function to an API
-
In the Service Development pane, click business process > API.
-
Find and double-click the API. The configuration tab of the API opens.
-
In the right-side navigation pane, click Filter.
-
On the Filter tab, select Use Pre-filter or Use Post-filter based on your requirements. The default Function Type is Aviator Function. Select one or more functions from the drop-down list. If you select multiple functions, they process the request parameters or responses in the order you selected them.
NoteIf a function does not appear in the drop-down list, it has not been published yet. Publish the function first. See Publish a function.
-
Click Preview Responses Returned by API Operation to verify that the output from the selected functions meets your expectations.