From 5d167ea6e943dd1574e0e6ed70ff25b8d4830f61 Mon Sep 17 00:00:00 2001
From: java110 <928255095@qq.com>
Date: 星期四, 16 六月 2022 11:47:49 +0800
Subject: [PATCH] 优化代码
---
docs/api/machine.md | 125 +++++++++++++++++++++++++++++++++++++++++
1 files changed, 125 insertions(+), 0 deletions(-)
diff --git a/docs/api/machine.md b/docs/api/machine.md
old mode 100644
new mode 100755
index ebd7f8d..bd78df4
--- a/docs/api/machine.md
+++ b/docs/api/machine.md
@@ -4,10 +4,135 @@
鏂囨。璇存槑璁惧鐩稿叧鎺ュ彛鍗忚
+HC灏忓尯绠＄悊绯荤粺婧愮爜鑾峰彇 https://gitee.com/wuxw7/MicroCommunity
+
## 涓氫富鑾峰彇瀵瑰簲璁惧
+璇存槑锛氭煡璇笟涓诲彲浠ュ紑闂ㄨ澶�
+
+璇锋眰鏂瑰紡锛� GET
+
+璇锋眰鍦板潃锛�/api/owner.listOwnerMachines
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| memberId | String | 鏄� | 772020123183100051 | 涓氫富ID |
+| communityId | String | 鏄� | 2020122471920846 | 灏忓尯ID |
+
+璇锋眰绀轰緥锛�
+```url
+
+http://ip:port/api/owner.listOwnerMachines?memberId=772020123183100051&communityId=2020122471920846
+
+```
+
+杩斿洖鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| direction | String | 鏄� | 3306 | 杩涘満 |
+| directionName | String | 鏄� | 杩涘満 | 涓枃鎻忚堪 |
+| heartbeatTime | String | 鏄� | 2020-12-31 18:06:40 | 璁惧鏈�杩戝績璺虫椂闂� |
+| locationObjId | String | 鏄� | 2020122471920846 | 浣嶇疆ID |
+| locationObjName | String | 鏄� | iot_灏忓尯 浣嶇疆3 | 浣嶇疆璇存槑 |
+| machineCode | String | 鏄� | 1368371 | 璁惧缂栫爜 |
+| machineId | String | 鏄� | 892020122872730977 | 璁惧ID |
+| machineIp | String | 鍚� | 192.168.1.1 | 璁惧IP |
+| machineMac | String | 鍚� | 11:11:11:11 | 璁惧mac |
+| machineName | String | 鏄� | 鍘﹂棬闆嗙編2 | 璁惧鍚嶇О |
+| machineTypeCd | String | 鏄� | 9999 | 琛ㄧず闂ㄧ |
+| machineTypeCdName | String | 鏄� | 闂ㄧ | 璁惧绫诲瀷璇存槑 |
+
+杩斿洖绀轰緥锛�
+```json
+{
+ "machines": [{
+ "direction": "3306",
+ "directionName": "杩涘満",
+ "heartbeatTime": "2020-12-31 18:06:40",
+ "locationObjId": "2020122471920846",
+ "locationObjName": "iot_灏忓尯 浣嶇疆3",
+ "machineCode": "1368371",
+ "machineId": "892020122872730977",
+ "machineIp": "",
+ "machineMac": "",
+ "machineName": "鍘﹂棬闆嗙編2",
+ "machineTypeCd": "9999",
+ "machineTypeCdName": "闂ㄧ"
+ }],
+ "page": 1,
+ "records": 1,
+ "rows": 1,
+ "total": 0
+}
+```
+
## 鐗╀笟鏌ヨ鎵�鏈夎澶�
+璇存槑锛氭煡璇笟涓诲彲浠ュ紑闂ㄨ澶�
+
+璇锋眰鏂瑰紡锛� GET
+
+璇锋眰鍦板潃锛�/api/machine.listMachines
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| page | Integer | 鏄� | 1 | 椤垫暟 |
+| row | Integer | 鏄� | 10 | 姣忛〉鏄剧ず鏁伴噺 |
+| communityId | String | 鏄� | 2020122471920846 | 灏忓尯ID |
+
+璇锋眰绀轰緥锛�
+```url
+
+http://ip:port/api/machine.listMachines?communityId=2020122471920846&page=1&row=10
+
+```
+
+杩斿洖鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| direction | String | 鏄� | 3306 | 杩涘満 |
+| directionName | String | 鏄� | 杩涘満 | 涓枃鎻忚堪 |
+| heartbeatTime | String | 鏄� | 2020-12-31 18:06:40 | 璁惧鏈�杩戝績璺虫椂闂� |
+| locationObjId | String | 鏄� | 2020122471920846 | 浣嶇疆ID |
+| locationObjName | String | 鏄� | iot_灏忓尯 浣嶇疆3 | 浣嶇疆璇存槑 |
+| machineCode | String | 鏄� | 1368371 | 璁惧缂栫爜 |
+| machineId | String | 鏄� | 892020122872730977 | 璁惧ID |
+| machineIp | String | 鍚� | 192.168.1.1 | 璁惧IP |
+| machineMac | String | 鍚� | 11:11:11:11 | 璁惧mac |
+| machineName | String | 鏄� | 鍘﹂棬闆嗙編2 | 璁惧鍚嶇О |
+| machineTypeCd | String | 鏄� | 9999 | 琛ㄧず闂ㄧ |
+| machineTypeCdName | String | 鏄� | 闂ㄧ | 璁惧绫诲瀷璇存槑 |
+
+杩斿洖绀轰緥锛�
+```json
+{
+ "machines": [{
+ "direction": "3306",
+ "directionName": "杩涘満",
+ "heartbeatTime": "2020-12-31 18:06:40",
+ "locationObjId": "2020122471920846",
+ "locationObjName": "iot_灏忓尯 浣嶇疆3",
+ "machineCode": "1368371",
+ "machineId": "892020122872730977",
+ "machineIp": "",
+ "machineMac": "",
+ "machineName": "鍘﹂棬闆嗙編2",
+ "machineTypeCd": "9999",
+ "machineTypeCdName": "闂ㄧ"
+ }],
+ "page": 1,
+ "records": 1,
+ "rows": 1,
+ "total": 0
+}
+```
+
## 杩滅▼寮�闂�
璇存槑锛氱墿涓氱郴缁焪eb绔紝涓氫富鎵嬫満绔垨鑰呯墿涓氭墜鏈虹増杩滅▼寮�闂ㄥ満鏅�
--
Gitblit v1.8.0