GET
/api/v1/devices
获取所有设备列表。返回设备信息,包括ID、名称、状态和类型。
请求参数
| 参数 |
类型 |
必填 |
说明 |
| page |
integer |
No |
页码(默认:1) |
| limit |
integer |
No |
每页数量(默认:10) |
响应示例
{
"code": 200,
"message": "success",
"data": {
"devices": [
{
"id": 1,
"name": "Device 1",
"status": "online",
"type": "sensor"
}
],
"total": 10,
"page": 1
}
}
POST
/api/v1/devices
创建新设备。需要设备名称、类型和配置信息。
请求体
| 参数 |
类型 |
必填 |
说明 |
| name |
string |
Yes |
设备名称 |
| type |
string |
Yes |
设备类型(传感器、执行器等) |
| config |
object |
No |
设备配置 |
请求示例
{
"name": "New Device",
"type": "sensor",
"config": {
"interval": 60,
"unit": "celsius"
}
}
响应示例
{
"code": 201,
"message": "Device created successfully",
"data": {
"id": 123,
"name": "New Device",
"status": "offline"
}
}
PUT
/api/v1/devices/{id}
更新设备信息。用提供的信息替换所有设备数据。
路径参数
请求示例
{
"name": "Updated Device",
"type": "actuator",
"config": {
"mode": "auto"
}
}
响应示例
{
"code": 200,
"message": "Device updated successfully",
"data": {
"id": 123,
"name": "Updated Device",
"type": "actuator"
}
}
DELETE
/api/v1/devices/{id}
根据ID删除设备。此操作无法撤销。
路径参数
| 参数 |
类型 |
说明 |
| id |
integer |
要删除的设备ID |
响应示例
{
"code": 200,
"message": "Device deleted successfully"
}
PATCH
/api/v1/devices/{id}/status
部分更新设备状态。仅更新指定字段,不影响其他数据。
请求体
| 参数 |
类型 |
必填 |
说明 |
| status |
string |
Yes |
设备状态(在线、离线、维护中) |
请求示例
{
"status": "online"
}
响应示例
{
"code": 200,
"message": "Device status updated",
"data": {
"id": 123,
"status": "online",
"updatedAt": "2024-01-15T10:30:00Z"
}
}
👉
联系我们获得完整文档或支持
👈