[Legacy] 数据库面向服务器的API - WNJXYK/JLU_DSD GitHub Wiki

由于系统结构设计的缘故，数据库模块 作为一个单独且独立的模块在内网中运行，并向 服务器模块 提供公网不可见的 Web API。 当前 数据库模块 提供的 API 分为两种：对终端的与对服务器的，允许使用 Get 或者 Post 请求进行访问。在接下来的内容中，将会介绍面向服务器提供的每个 API 的功能、调用参数与具体返回。

对 服务器模块 提供的 API

1. /server/Hardware

   接口功能： 返回某一个房间中可操作硬件 / 不可操作硬件的编号列表

   参数列表：

   RID : 房间编号
   Ctrl : 选择可操作 / 不可操作硬件
   

   正常返回(示例)：

   { 
       "status" : 0,
       "info" : [1, 2, 3] // 符合条件的硬件列表
   }
   

   异常返回：

   // 服务器异常
   { 
       "status" : -2,
       "msg" : "Some Reasons" // 服务器异常原因
   }
   

   其他说明： 无

2. '/server/room'

   接口功能： 返回某一硬件更改影响的房间列表 / 所有房间列表。当请求参数中不存在 HID 时返回所有房间列表，否则返回 HID 硬件影响的所有房间的列表。

   参数列表：

   HID : 硬件编号[可选参数]
   

   正常返回(示例)：

   { 
       "status" : 0,
       "info" : [1, 2, 3] // 符合条件的房间列表
   }
   

   异常返回：

   // 服务器异常
   { 
       "status" : -2,
       "msg" : "Some Reasons" // 服务器异常原因
   }
   

   其他说明： 无

3. /server/hardwareInfo

   接口功能： 返回某一硬件的可持久化信息

   参数列表：

   HID : 硬件编号
   

   正常返回(示例)：

   { 
       "status" : 0,
       "info" : {
           "hid" : 1, // 硬件编号
           "nickname" : "Name", // 硬件昵称
           "type" : "Light", // 硬件类型
           "ctrl" : 1 // 硬件是否可以操作
       }
   }
   

   异常返回：

   // 服务器异常
   { 
       "status" : -2,
       "msg" : "Some Reasons" // 服务器异常原因
   }
   

   其他说明： 无

4. /server/userInfo

   接口功能： 返回某一个用户的信息

   参数列表：

   UID : 用户编号
   

   正常返回(示例)：

   { 
       "status" : 0,
       "info" : {
           "uid" : 1, // 用户编号
           "nickname" : "User", // 用户昵称
           "authority" : 1 // 用户权限等级
       }
   }
   

   异常返回：

   // 服务器异常
   { 
       "status" : -2,
       "msg" : "Some Reasons" // 服务器异常原因
   }
   

   其他说明： 无