SECUREXSECURITY ENGINEERINGNVR 文档

Schema API

Schema API 用于让客户端了解配置或数据结构。它适合生成表单、校验输入和版本兼容检查,不应被当作业务数据接口。

核心说明

本页内容按该功能本身整理,不再使用通用占位说明。以下项目均与当前主题直接相关。

版本

Schema 会随服务器版本变化,客户端应按服务器返回内容处理。

校验

提交配置前可用 schema 做类型、枚举和必填字段验证。

未知字段

不要静默丢弃未知字段;应提示用户该版本是否支持。

UI

表单生成器应保留高级 YAML 编辑入口,避免 schema UI 限制专业配置。

验证与排查

  • 修改或执行前记录当前版本/配置,以便回退。
  • 完成后同时检查 UI 状态和后端日志,不只看一个成功提示。
  • 如果问题只在单个摄像头/插件出现,先做最小范围对比,避免全局改动。

Schemas API

Schema APIs expose configuration/data structure metadata for validation, forms and compatibility checks.

Core behavior

This page is topic-specific rather than a generic placeholder.

Versioning

Schemas can change with server versions.

Validation

Use schema for type/enum/required-field validation.

Unknown fields

Do not silently discard unsupported fields.

UI

Keep an advanced YAML path alongside generated forms.

Verification and troubleshooting

  • Record the current version/config before changes so rollback is possible.
  • Verify both UI state and backend logs after the change.
  • If only one camera/plugin is affected, isolate it before making global changes.

API de esquemas

La API Schema expone estructura para validación, formularios y compatibilidad.

Comportamiento

Esta página contiene contenido específico del tema, no un texto genérico.

Versiones

El esquema cambia con la versión.

Validación

Use schema para tipos, enums y obligatorios.

Campos desconocidos

No descarte campos sin avisar.

UI

Mantenga edición YAML avanzada.

Verificación y diagnóstico

  • Registre versión/configuración antes de cambiar para poder revertir.
  • Compruebe UI y logs del backend después.
  • Si afecta a una sola cámara/plugin, aíslelo antes de cambios globales.
输入关键词开始搜索