api文档

This commit is contained in:
houwei 2024-06-28 13:14:24 +08:00
parent 69bad4c70e
commit 4a1ba99b55

View File

@ -2,27 +2,30 @@
## API接口一览表
| 接口分类 | 接口描述 | API接口 | 权限 |
| ------------- | -------------------------------- | ------------------------------------- | ---------------------- |
| 2.1设备类型 | 2.1.1获取所有设备类型信息 | /api/equipment/type/list | |
| 2.2物模型 | 2.2.1获取物模型列表 | /api/equipment/model/list | |
| | 2.2.2物模型新增 | /api/equipment/model/add | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.3物模型修改 | /api/equipment/model/update | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.4物模型删除 | /api/equipment/model/delete | SYS_AUTHORITY_ID_ADMIN |
| 2.2物模型属性 | 2.2.5获取物模型属性列表 | /api/equipment/model/attribute/list | |
| | 2.2.6物模型属性新增 | /api/equipment/model/attribute/add | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.7物模型属性修改 | /api/equipment/model/attribute/update | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.8物模型属性删除 | /api/equipment/model/attribute/delete | SYS_AUTHORITY_ID_ADMIN |
| 2.2物模型方法 | 2.2.9获取物模型方法列表 | /api/equipment/model/service/list | |
| | 2.2.10物模型方法新增 | /api/equipment/model/service/add | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.11物模型方法修改 | /api/equipment/model/service/update | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.12物模型方法删除 | /api/equipment/model/service/delete | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.13 Excel导出物模型属性和方法 | /api/equipment/model/export | |
| | 2.2.14 Excel导入物模型属性和方法 | /api/equipment/model/import | SYS_AUTHORITY_ID_ADMIN |
| 2.3设备台账 | 2.3.1 设备查询 | | |
| | 2.3.2 设备新增 | | |
| | 2.3.3 设备修改 | | |
| | 2.3.4 设备删除 | | |
| 接口分类 | 接口描述 | API接口 | 权限 |
| ------------- | -------------------------------- | ------------------------------------- | ---------------------------- |
| 2.1设备类型 | 2.1.1获取所有设备类型信息 | /api/equipment/type/list | |
| 2.2物模型 | 2.2.1获取物模型列表 | /api/equipment/model/list | |
| | 2.2.2物模型新增 | /api/equipment/model/add | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.3物模型修改 | /api/equipment/model/update | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.4物模型删除 | /api/equipment/model/delete | SYS_AUTHORITY_ID_ADMIN |
| 2.2物模型属性 | 2.2.5获取物模型属性列表 | /api/equipment/model/attribute/list | |
| | 2.2.6物模型属性新增 | /api/equipment/model/attribute/add | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.7物模型属性修改 | /api/equipment/model/attribute/update | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.8物模型属性删除 | /api/equipment/model/attribute/delete | SYS_AUTHORITY_ID_ADMIN |
| 2.2物模型方法 | 2.2.9获取物模型方法列表 | /api/equipment/model/service/list | |
| | 2.2.10物模型方法新增 | /api/equipment/model/service/add | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.11物模型方法修改 | /api/equipment/model/service/update | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.12物模型方法删除 | /api/equipment/model/service/delete | SYS_AUTHORITY_ID_ADMIN |
| | 2.2.13 Excel导出物模型属性和方法 | /api/equipment/model/export | |
| | 2.2.14 Excel导入物模型属性和方法 | /api/equipment/model/import | SYS_AUTHORITY_ID_ADMIN |
| 2.3设备台账 | 2.3.1 设备分页查询 | /api/equipment/query | SYS_AUTHORITY_ID_DEVICE_VIEW |
| | 2.3.2 设备不分页查询 | /api/equipment/list | SYS_AUTHORITY_ID_DEVICE_VIEW |
| | 2.3.3 设备新增 | /api/equipment/add | SYS_AUTHORITY_ID_DEVICE_MGR |
| | 2.3.4 设备修改 | /api/equipment/update | SYS_AUTHORITY_ID_DEVICE_MGR |
| | 2.3.5 设备删除 | /api/equipment/delete | SYS_AUTHORITY_ID_DEVICE_MGR |
| | 2.3.6 Excel导出设备清单 | /api/equipment/export | SYS_AUTHORITY_ID_DEVICE_VIEW |
| | 2.3.7 Excel导入设备清单 | /api/equipment/import | SYS_AUTHORITY_ID_DEVICE_MGR |
### 2.1 设备类型相关接口
@ -585,7 +588,40 @@ POST 请求接口
#### 2.2.14 Excel导入物模型属性和方法
Excel导入
### 2.3 设备台账相关接口
#### 2.3.1 设备分页查询
> /api/equipment/query
>
>
#### 2.3.2 设备不分页查询
> /api/equipment/list
>
>
#### 2.3.3 设备新增
> /api/equipment/add
#### 2.3.4 设备修改
> /api/equipment/update
#### 2.3.5 设备删除
> /api/equipment/delete
#### 2.3.6 Excel导出设备清单
> /api/equipment/export
#### 2.3.7 Excel导入设备清单
> /api/equipment/import