文档

使用函数作为API过滤器

更新时间:

本文为您介绍如何使用函数作为API的前置或后置过滤器。

前提条件

背景信息

您可以在数据服务中创建函数、测试函数、发布函数,发布后的函数可被进一步关联至API,作为API的过滤器,对API的请求参数或返回结果进行加工处理,从而实现API的复杂查询需求,灵活适配各类业务场景。常见场景的代码示例请参见:使用Aviator函数作为过滤器的最佳实践

使用限制

  • 当使用函数作为API过滤器时,前置过滤器和后置过滤器的函数类型需要保持一致。即:均选择Aviator函数类型或Python函数类型。暂不支持对同一API的前置和后置过滤器选择不同的函数类型。

  • Python函数正在改造中,暂不支持新建、克隆和发布新的Python函数。

使用函数作为API的过滤器

  1. 服务开发页面,展开目标API所在的业务流程 > API

  2. 双击相应的API名称,打开该API的编辑页面。

  3. 单击页面右侧的过滤器

    根据需要勾选使用前置过滤器使用后置过滤器函数类型默认为Aviator函数,单击前置过滤器或后置过滤器右侧的下拉框选择目标函数(可添加多个函数,执行时会按照函数的添加顺序对API参数进行处理)。

    说明
    • 过滤器由一个或多个函数组成,允许您对API的请求参数进行预处理或对查询结果进行二次加工。

    • 若在下拉列表中无法获取目标函数名称,请检查目标函数是否已发布,或尝试新建函数并发布。详情请参见发布函数

  4. 单击API返回结果预览,查看使用过滤器后的结果是否符合预期。

  • 本页导读 (1)
文档反馈