本文为您介绍如何使用过滤器,对API生成结果进行深入处理。

什么是过滤器

数据服务过滤器是用于对API生成结果进一步处理的动态函数。通过指定一个或者多个过滤器,您可以实现自定义API返回结构,对API的数据进行进一步的加工。
  • 过滤器目前仅支持Python 3.0的语法。
  • 过滤器目前仅支持import json,time,random,pickle,re,math
  • 过滤器限定函数名def handler(event,context):

函数结构说明

系统自带的模板函数如下。
# -*- coding: utf-8 -*-

# event (str) : in filter it is the API result, in other cases, it is your param
# context : some environment information, temporarily useless
# import module limit: json,time,random,pickle,re,math
# do not modify function name
import json
def handler(event,context):
# load str to json object
obj = json.loads(event) # 转化为JSON object。
# add your code here
# end add
return obj
您可以基于该函数进行修改,函数的入参名称不是强制要求,可以根据自身需求修改名称入参。
参数1[context]:字符串类型,包含API执行的上下文环境,目前为空,暂未启用。  
参数2[event]:字符串类型,包含API执行的结果,或者是上一个过滤器处理后的结果。

新建过滤器

说明 您需要购买DataWorks专业版及以上版本,才可以新建Python函数。
  1. 登录DataWorks控制台,单击相应工作空间后的进入数据开发
  2. 单击左上角的图标,选择全部产品 > 数据服务
  3. 数据服务页面,单击左侧导航栏中的函数
  4. 鼠标悬停至新建,单击新建Python函数
  5. 配置新建Python函数对话框中的参数。配置
    参数 描述
    函数名称 自定义函数名称,不超过64个字符。
    函数模板 目前仅支持Python3 Standard v1模板。
    运行环境 目前仅支持Python 3.0。
    函数描述 对函数进行简单描述。
    目标文件夹 选择函数存放的文件夹。
  6. 配置完成后,单击确认

使用过滤器

  1. 单击左侧导航栏中的服务开发
  2. API列表中,双击打开相应的API,单击右侧的返回参数返回参数
  3. 勾选使用过滤器,并选择新建的函数。
    说明 您可以在函数面板中新建函数作为过滤器,对API查询结果进行二次处理。
  4. 单击结果预览,即可查看使用过滤器后的数据。