Skip to content
On this page

Anim 接口灰度插件

Anim 提供了接口灰度插件,可以配合后端的灰度配置实现基于接口的灰度能力。

快速使用

安装插件

bash
# 使用 npm 安装
npm install @ssv-lab/anim-plugin-api-gray --save

注意该 npm 包为 Coding Npm 的私有源,请先确定已经正确配置了 Coding Npm

  1. 点击开发者工具中的菜单栏:工具 --> 构建 npm
  2. 点击开发者工具中的菜单栏:设置 --> 项目设置 --> 勾选“使用 npm 模块”选项
  3. 构建完成后即可使用

初始化插件

js
// app.js
import Anim from '@ssv-lab/anim'
import GrayPlugin from '@ssv-lab/anim-plugin-api-gray'

Anim
  .use(GrayPlugin, {
    // 灰度字段
    grayKeys: ['X-SSV-GREY-INFO', 'X-SSV-UID']
  })

小程序使用 npm 包,请参考 小程序使用 npm 包

配置参数

options.grayKeys

允许配置多个灰度字段,当接口返回的 Header 内有包含在 options.grayKeys 中的字段时,会自动进行灰度处理。下一次请求时,会自动携带上一次请求的灰度字段,以此来实现灰度。

使用场景案例

当我们需要根据指定用户进行灰度时,后端可以在登录接口返回的 Header 中添加灰度字段,如 X-SSV-UID。后续的接口调用下,Anim 插件会根据配置将 X-SSV-UID 传递给后端,后端可以在后续的业务逻辑中根据指定白名单列表。自行实现灰度逻辑。

其他

若想使用小程序灰度,请参照小程序的灰度文档:小程序版本发布

Released under the MIT License.