Skip to content

API_SWAGGER_V2.md

Latest commit

 

History

History
51 lines (35 loc) · 1.54 KB

API_SWAGGER_V2.md

File metadata and controls

51 lines (35 loc) · 1.54 KB
Raw

EL Detect 数据接口 Swagger（v2）

  • OpenAPI版本: 3.0.3
  • 基础路径: /api/v2
  • 传输格式: JSON

核心接口

  • POST /api/v2/collect/camera-stream

    • 说明: 摄像头实时视频流异步采集（支持 RTSP/RTMP）
    • 关键字段: streamUrl, protocol, deviceId, frameUri, boxes[]

  • POST /api/v2/collect/local-video

    • 说明: 本地视频解析（支持 MP4/AVI）
    • 关键字段: videoUri, fileName, durationSec, fps, frameUris[]

  • POST /api/v2/collect/image-batch

    • 说明: 图片批量导入（支持 JPEG/PNG）
    • 关键字段: imageUris[], expectedMd5, rotateDegree, scaleRatio, normalize

  • POST /api/v2/storage/archive

    • 说明: 按时间维度归档分区

  • GET /api/v2/storage/consistency

    • 说明: MySQL/Mongo 双写一致性校验

  • POST /api/v2/storage/reconcile-daily

    • 说明: 每日对账报告生成

v1/v2 兼容

  • 兼容入口：ingestDetectionV1(payload)
  • 适配策略：根据 sourceType 自动转发到 v2 摄像头/视频/图片接口

错误码

  • 0: 成功
  • -1: 失败（参数错误、格式不支持、校验失败、存储异常）

性能监控 Dashboard

  • 通过 DetectionDataService.getPerformanceDashboard(windowSeconds) 获取：
    • QPS
    • 平均延迟
    • P95延迟
    • 可用性

SLA 目标

  • 接口目标响应时间：< 200ms（业务轻负载场景）
  • 生产环境需结合设备性能与存储介质进行压测校准