OpenAPI

开放 API 规范

定义

OpenAPI(原 Swagger)是描述 RESTful API 的开放规范,定义接口路径、参数、响应格式等。设备管理平台提供 OpenAPI 文档,便于第三方系统集成设备管理、数据查询、OTA 等能力,与 RESTful API 配套使用。

规范内容与工具链

OpenAPI 3.x 使用 YAML/JSON 描述 API 的路径、方法、请求/响应 Schema、鉴权方式等。基于规范可自动生成交互式文档(Swagger UI)、客户端 SDK、服务端桩代码及 Mock 服务。设备管理平台通常为设备 CRUD、产品管理、OTA 任务、告警订阅、数据查询等接口提供 OpenAPI 定义;支持版本管理(如 /v1、/v2),便于 API 演进与兼容。

与 DMP 的集成

平台通过 OpenAPI 文档降低集成门槛,第三方可通过文档理解接口、生成代码、进行联调。与 Webhook 回调、Event Stream 事件流等能力配合,可构建完整的集成生态。文档可托管于平台或导出供离线使用;支持 Try it out 在线调试,提升开发者体验。API 网关可基于 OpenAPI 进行请求校验、限流与监控。

应用场景

适用于系统集成、自动化运维、第三方应用开发、BI 工具对接等。OpenAPI 是设备管理平台开放能力的标准载体,有助于构建合作伙伴生态与加速业务集成。

相关术语

返回设备管理平台专业术语