openbankingbrasil/metrics-validator

巴西开放银行指标API验证器（API Admin）

镜像概述

Open Banking规范中定义了https://openbanking-brasil.github.io/areadesenvolvedor/#obtem-as-metricas-de-disponibilidade-das-apis%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%8F%90%E4%BE%9B%E5%8F%82%E4%B8%8E%E6%9C%BA%E6%9E%84Open Banking生态系统中其他API的可用性信息。本镜像提供的验证器用于检查发送到该应用的Payload是否符合该API的文档规范，确保参与机构能够验证其API的响应有效性。

核心功能

• 验证API Admin（指标API）响应Payload的结构和内容
• 逐属性检查Payload是否符合Open Banking文档规范
• 提供详细的验证错误信息，包括具体字段和错误原因
• 支持标准的HTTP接口，便于集成到现有系统中

使用场景

• Open Banking参与机构验证其API Admin实现的正确性
• 开发和测试阶段确保API响应符合规范要求
• 监控和审计API响应质量，确保合规性

使用方法

1. 下载镜像

bash
$ docker pull openbankingbrasil/metrics-validator:latest

2. 启动容器

bash
$ docker run -dp 3005:3005 openbankingbrasil/metrics-validator

容器启动后，验证服务将在本地3005端口运行。

3. 验证Payload

通过发送POST请求到以下端点进行Payload验证：

POST http://localhost:3005/validator/metrics

请求Payload格式

输入Payload需符合https://openbanking-brasil.github.io/areadesenvolvedor/#obtem-as-metricas-de-disponibilidade-das-apis%E7%9A%84%E8%A7%84%E8%8C%83%EF%BC%8C%E9%9C%80%E5%B0%86%E6%8C%87%E6%A0%87API%EF%BC%88API Admin）的响应包含在"resource"属性中。

请求示例

json
{
  "data": {
    "requestTime": "teste",
    "errors": {
      "currentDay": 10,
      "previousDays": [
        270,
        298,
        303,
        244,
        274,
        249,
        253
      ]
    },
    "peakTps": {
      "currentDay": 10,
      "previousDays": [
        2,
        2,
        2,
        2,
        2,
        2,
        2
      ]
    },
    "averageTps": {
      "currentDay": 10,
      "previousDays": [
        1,
        1,
        1,
        1,
        1,
        1,
        1
      ]
    },
    "rejections": {
      "currentDay": 10,
      "previousDays": [
        137,
        149,
        115,
        125,
        152,
        141,
        148
      ]
    },
    "availability": {
      "uptime": {
        "generalUptimeRate": "0.99",
        "endpoints": [
          {
            "url": "https://api.demo.obconnect.io/br/open-banking/products-services/v1",
            "uptimeRate": "0.99"
          },
          {
            "url": "https://api.demo.obconnect.io/br/open-banking/discovery/v1",
            "uptimeRate": "0.99"
          },
          {
            "url": "https://api.demo.obconnect.io/br/open-banking/channels/v1",
            "uptimeRate": "0.99"
          }
        ]
      },
      "downtime": {
        "generalDowntime": 153,
        "scheduledOutage": 0,
        "endpoints": [
          {
            "url": "https://api.demo.obconnect.io/br/open-banking/products-services/v1",
            "partialDowntime": 67
          },
          {
            "url": "https://api.demo.obconnect.io/br/open-banking/discovery/v1",
            "partialDowntime": 7
          },
          {
            "url": "https://api.demo.obconnect.io/br/open-banking/channels/v1",
            "partialDowntime": 79
          }
        ]
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 384,
        "previousDays": [
          453,
          416,
          415,
          375,
          433,
          452,
          407
        ]
      },
      "unattended": {
        "currentDay": 84,
        "previousDays": [
          78,
          71,
          81,
          56,
          81,
          72,
          79
        ]
      },
      "highPriority": {
        "currentDay": 205,
        "previousDays": [
          208,
          221,
          195,
          180,
          210,
          189,
          216
        ]
      },
      "mediumPriority": {
        "currentDay": 713,
        "previousDays": [
          635,
          762,
          670,
          655,
          722,
          637,
          662
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 1027,
        "previousDays": [
          1024,
          1004,
          970,
          1012,
          995,
          1021,
          981
        ]
      },
      "unattended": {
        "currentDay": 919,
        "previousDays": [
          972,
          1103,
          1018,
          941,
          985,
          911,
          1016
        ]
      },
      "highPriority": {
        "currentDay": 1053,
        "previousDays": [
          1012,
          963,
          981,
          1029,
          1019,
          974,
          1001
        ]
      },
      "mediumPriority": {
        "currentDay": 985,
        "previousDays": [
          983,
          1011,
          1029,
          1013,
          999,
          1004,
          994
        ]
      }
    }
  }
}

响应说明

• 验证通过：返回空错误数组和200状态码

json
{
    "data": [],
    "status": 200
}

• 验证失败：返回包含错误信息的数组和200状态码，错误信息说明具体字段的问题

json
{
  "data": [
    "instance.resource.data.invocations.unattended.previousDays does not meet minimum length of 7",
    "instance.resource.data.invocations.mediumPriority.currentDay is not of a type(s) integer",
    "instance.resource.data.averageResponse.unattended.previousDays[4] is not of a type(s) integer"
  ],
  "status": 200
}

错误示例解释

• instance.resource.data.invocations.unattended.previousDays does not meet minimum length of 7：根据文档，"previousDays"数组必须至少包含7个元素
• instance.resource.data.invocations.mediumPriority.currentDay is not of a type(s) integer："currentDay"属性必须是整数类型
• instance.resource.data.averageResponse.unattended.previousDays[4] is not of a type(s) integer："previousDays"数组的第4个元素必须是整数类型