孪生接口

数据接口#

接口协议#

websocket

接口地址#

http://ip:port/ws

场景订阅接口#

当连接成功后,用于告知服务端,关注的资源清单。

{
  "action": "subscribe",
  "resources": [
    { "type": "upf", "id": "001" },
    { "type": "upf", "id": "002" }
  ]
}

资源刷新接口#

1、当服务端收到订阅消息的时候,补全其他属性,并通知客户端。

{
  "action": "refresh",
  "resources": [
    {
      "type": "upf",
      "id": "001",
      "label": "资源类型:UPF\r\n资源标识:001\r\n资源名称:001号UPF",
      "color": "", //十六进制值:0xff0000
      "effect": "" //闪烁:flash,泛光:shadow
    },
    {
      "type": "upf",
      "id": "002",
      "label": "资源类型:UPF\r\n资源标识:002\r\n资源名称:002号UPF",
      "color": "",
      "effect": ""
    }
  ]
}

2、当资源有变化的时候,更新相关属性,并通知客户端。

{
  "action": "refresh",
  "resources": [
    {
      "type": "upf",
      "id": "001",
      "label": "资源类型:UPF\r\n资源标识:001\r\n资源名称:001号UPF\r\n告警级别:紧急\r\n告警原因:断开连接",
      "color": "0xff0000",
      "effect": ""
    }
  ]
}

样例代码#

后端代码

// todo

前端代码

<!-- todo -->

页面接口#

接口协议#

postMessage

模型操作通知接口#

{
  "action": "checked", // 选中:checked,去选中:unchecked
  "resource": { "type": "upf", "id": "001" }
}

样例代码#

// todo
本作品采用《CC 协议》,转载必须注明作者和本文链接
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。