Browse Source

增加描述信息

luoguangyi 3 years ago
parent
commit
0a478d0235
1 changed files with 60 additions and 0 deletions
  1. 60 0
      README.md

+ 60 - 0
README.md

@@ -9,3 +9,63 @@
 - ###### 一式两份之间配置相同,通过配置文件中的iot.type.cloud和iot.type.edge来设置是部署在哪一侧;
 
 ###### 
+
+### 测试服务启动状态
+
+> http://127.0.0.1:8863/test/
+
+接口描述
+
+```
+
+```
+
+post请求
+
+参数例子
+
+```
+{}
+```
+
+成功示例
+
+```
+hello world!
+```
+
+### 测试给kafka发送消息
+
+> http://127.0.0.1:8863/test/sendKafka
+
+接口描述
+
+```
+/隔开的参数n选1
+```
+
+post请求
+
+参数例子
+
+```
+{
+    "topic": "iot.edge2collect/iot.edge2control/iot.collect2edge/iot.control2edge",
+    "packetEntity": {
+        "address": "",
+        "projectId": "4403050019",
+        "type": "tcpControl/tcpCollect(边缘都到云端发送消息的时候需要指定)",
+        "content": {
+            "packetString": "3201130004;1;report;20210418000145;5864;30000;1;10101;6.06"
+        }
+    }
+}
+```
+
+成功示例
+
+```
+发送数据的长度
+```
+
+##