Parcourir la source

代码生成器生成相应协议

wuxw il y a 7 ans
Parent
commit
78f710161a

+ 2 - 0
docs/_sidebar.md

@@ -36,6 +36,8 @@
   * [小区成员入驻](services/community/communityMemberJoined.md)
   * [小区成员退出](services/community/communityMemberQuit.md)
   * [保存小区楼](services/floor/SaveFloorInfo.md)
+  * [修改小区楼](services/floor/UpdateFloorInfo.md)
+  * [删除小区楼](services/floor/DeleteFloorInfo.md)
 
 * 工具类接口
 

+ 114 - 0
docs/services/floor/DeleteFloorInfo.md

@@ -0,0 +1,114 @@
+
+
+**1\. 删除小区楼**
+###### 接口功能
+> API服务做删除小区楼时调用该接口
+
+###### URL
+> [http://floor-service/floorApi/service](http://floor-service/floorApi/service)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> POST
+
+###### 协议接口
+|父元素名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-:|
+|-|orders|1|Object|-|订单节点|-|
+|-|business|1|Array|-|业务节点|-|
+
+###### orders
+|父元素名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
+|-|orders|1|Object|-|订单节点|-|
+|orders|appId|1|String|10|系统ID|由中心服务提供|
+|orders|transactionId|1|String|30|交互流水|appId+'00'+YYYYMMDD+10位序列|
+|orders|userId|1|String|30|用户ID|已有用户ID|
+|orders|orderTypeCd|1|String|4|订单类型|查看订单类型说明|
+|orders|requestTime|1|String|14|请求时间|YYYYMMDDhhmmss|
+|orders|remark|1|String|200|备注|备注|
+|orders|sign|?|String|64|签名|查看加密说明|
+|orders|attrs|?|Array|-|订单属性|-|
+|attrs|specCd|1|String|12|规格编码|由中心服务提供|
+|attrs|value|1|String|50|属性值|-|
+|orders|response|1|Object|-|返回结果节点|-|
+|response|code|1|String|4|返回状态|查看状态说明|
+|response|message|1|String|200|返回状态描述|-|
+
+###### business
+|父元素名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
+|-|business|?|Array|-|业务节点|-|
+|business|businessTypeCd|1|String|12|业务类型编码|500100030002|
+|business|datas|1|Object|-|数据节点|不同的服务下的节点不一样|
+|datas|businessFloorInfo|1|Object|-|小区成员|小区成员|
+|businessFloorInfo|floorId|1|String|30|-|-|
+
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+
+
+
+###### 举例
+> 地址:[http://floor-service/floorApi/service](http://floor-service/floorApi/service)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+
+请求报文:
+
+{
+  "orders": {
+    "appId": "外系统ID,分配得到",
+    "transactionId": "100000000020180409224736000001",
+    "userId": "用户ID",
+    "orderTypeCd": "订单类型,查询,受理",
+    "requestTime": "20180409224736",
+    "remark": "备注",
+    "sign": "这个服务是否要求MD5签名",
+    "businessType":"I",
+    "attrs": [{
+      "specCd": "配置的字段ID",
+      "value": "具体值"
+    }]
+  },
+  "business": {
+    "businessTypeCd": "510100050001",
+    "bId":"1234567892",
+    "remark": "备注",
+    "datas": {
+      "businessFloorInfo": {
+                "floorId":"填写存在的值"
+      }
+    },
+    "attrs": [{
+      "specCd": "配置的字段ID",
+      "value": "具体值"
+    }]
+  }
+}
+
+返回报文:
+ {
+	"orderTypeCd": "D",
+	"response": {
+		"code": "0000",
+		"message": "成功"
+	},
+	"responseTime": "20190418102004",
+	"bId": "202019041810750003",
+	"businessType": "B",
+	"transactionId": "3a5a411ec65a4c3f895935638aa1d2bc",
+	"dataFlowId": "44fde86d39ce46f4b4aab5f6b14f3947"
+}
+
+```

+ 2 - 6
docs/services/floor/SaveFloorInfo.md

@@ -45,10 +45,8 @@
 |business|datas|1|Object|-|数据节点|不同的服务下的节点不一样|
 |datas|businessFloorInfo|1|Object|-|小区成员|小区成员|
 |businessFloorInfo|floorId|1|String|30|-|-|
-|businessFloorInfo|operate|1|String|30|-|-|
-|businessFloorInfo|statusCd|1|String|30|-|-|
+|businessFloorInfo|name|1|String|30|-|-|
 |businessFloorInfo|remark|1|String|30|-|-|
-|businessFloorInfo|bId|1|String|30|-|-|
 |businessFloorInfo|userId|1|String|30|-|-|
 |businessFloorInfo|floorNum|1|String|30|-|-|
 
@@ -94,10 +92,8 @@ Content-Type:application/json
     "datas": {
       "businessFloorInfo": {
                 "floorId":"填写具体值",
-        "operate":"填写具体值",
-        "statusCd":"填写具体值",
+        "name":"填写具体值",
         "remark":"填写具体值",
-        "bId":"填写具体值",
         "userId":"填写具体值",
         "floorNum":"填写具体值"
       }

+ 122 - 0
docs/services/floor/UpdateFloorInfo.md

@@ -0,0 +1,122 @@
+
+
+**1\. 修改小区楼**
+###### 接口功能
+> API服务做修改小区楼时调用该接口
+
+###### URL
+> [http://floor-service/floorApi/service](http://floor-service/floorApi/service)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> POST
+
+###### 协议接口
+|父元素名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-:|
+|-|orders|1|Object|-|订单节点|-|
+|-|business|1|Array|-|业务节点|-|
+
+###### orders
+|父元素名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
+|-|orders|1|Object|-|订单节点|-|
+|orders|appId|1|String|10|系统ID|由中心服务提供|
+|orders|transactionId|1|String|30|交互流水|appId+'00'+YYYYMMDD+10位序列|
+|orders|userId|1|String|30|用户ID|已有用户ID|
+|orders|orderTypeCd|1|String|4|订单类型|查看订单类型说明|
+|orders|requestTime|1|String|14|请求时间|YYYYMMDDhhmmss|
+|orders|remark|1|String|200|备注|备注|
+|orders|sign|?|String|64|签名|查看加密说明|
+|orders|attrs|?|Array|-|订单属性|-|
+|attrs|specCd|1|String|12|规格编码|由中心服务提供|
+|attrs|value|1|String|50|属性值|-|
+|orders|response|1|Object|-|返回结果节点|-|
+|response|code|1|String|4|返回状态|查看状态说明|
+|response|message|1|String|200|返回状态描述|-|
+
+###### business
+|父元素名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
+|-|business|?|Array|-|业务节点|-|
+|business|businessTypeCd|1|String|12|业务类型编码|500100030002|
+|business|datas|1|Object|-|数据节点|不同的服务下的节点不一样|
+|datas|businessFloorInfo|1|Object|-|小区成员|小区成员|
+|businessFloorInfo|floorId|1|String|30|-|-|
+|businessFloorInfo|name|1|String|30|-|-|
+|businessFloorInfo|remark|1|String|30|-|-|
+|businessFloorInfo|userId|1|String|30|-|-|
+|businessFloorInfo|floorNum|1|String|30|-|-|
+
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+
+
+
+###### 举例
+> 地址:[http://floor-service/floorApi/service](http://floor-service/floorApi/service)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+
+请求报文:
+
+{
+  "orders": {
+    "appId": "外系统ID,分配得到",
+    "transactionId": "100000000020180409224736000001",
+    "userId": "用户ID",
+    "orderTypeCd": "订单类型,查询,受理",
+    "requestTime": "20180409224736",
+    "remark": "备注",
+    "sign": "这个服务是否要求MD5签名",
+    "businessType":"I",
+    "attrs": [{
+      "specCd": "配置的字段ID",
+      "value": "具体值"
+    }]
+  },
+  "business": {
+    "businessTypeCd": "510100040001",
+    "bId":"1234567892",
+    "remark": "备注",
+    "datas": {
+      "businessFloorInfo": {
+                "floorId":"填写具体值",
+        "name":"填写具体值",
+        "remark":"填写具体值",
+        "userId":"填写具体值",
+        "floorNum":"填写具体值"
+      }
+    },
+    "attrs": [{
+      "specCd": "配置的字段ID",
+      "value": "具体值"
+    }]
+  }
+}
+
+返回报文:
+ {
+	"orderTypeCd": "D",
+	"response": {
+		"code": "0000",
+		"message": "成功"
+	},
+	"responseTime": "20190418102004",
+	"bId": "202019041810750003",
+	"businessType": "B",
+	"transactionId": "3a5a411ec65a4c3f895935638aa1d2bc",
+	"dataFlowId": "44fde86d39ce46f4b4aab5f6b14f3947"
+}
+
+```

+ 28 - 0
java110-code-generator/src/main/java/com/java110/code/GeneratorDeleteInfoListener.java

@@ -1,5 +1,7 @@
 package com.java110.code;
 
+import java.util.Map;
+
 public class GeneratorDeleteInfoListener extends BaseGenerator {
 
 
@@ -21,5 +23,31 @@ public class GeneratorDeleteInfoListener extends BaseGenerator {
         String writePath = this.getClass().getResource("/listener").getPath()+"/Delete"+toUpperCaseFirstOne(data.getName())+"InfoListener.java";
         writeFile(writePath,
                 fileContext);
+
+        //生成协议
+
+        /**
+         * |businessstoreMember|memberTypeCd|1|String|30|成员类型|成员类型|
+         */
+        StringBuffer sbDoc = readFile(this.getClass().getResource("/template/serviceDoc.txt").getFile());
+        String fileContextDoc = sbDoc.toString();
+        fileContextDoc = fileContextDoc.replace("store",toLowerCaseFirstOne(data.getName()))
+                .replace("Store",toUpperCaseFirstOne(data.getName()))
+                .replace("商户",data.getDesc())
+                .replace("保存","删除")
+                .replace("$businessTypeCd$",data.getDeleteBusinessTypeCdValue());
+
+        Map<String,String> tmpParams = data.getParams();
+        String tmpLine = "";
+        String _tmpLine ="";
+            tmpLine += "|business"+toUpperCaseFirstOne(data.getName())+"Info|"+data.getId()+"|1|String|30|-|-|\n";
+            _tmpLine += "        \""+data.getId()+"\":\"填写存在的值\",\n";
+        _tmpLine = _tmpLine.substring(0,_tmpLine.lastIndexOf(","));
+        fileContextDoc = fileContextDoc.replace("$busienssInfo$",tmpLine);
+        fileContextDoc = fileContextDoc.replace("$businessInfoJson$",_tmpLine);
+        System.out.println(this.getClass().getResource("/listener").getPath());
+        String writePathDoc = this.getClass().getResource("/listener").getPath()+"/Delete"+toUpperCaseFirstOne(data.getName())+"Info.md";
+        writeFile(writePathDoc,
+                fileContextDoc);
     }
 }

+ 3 - 0
java110-code-generator/src/main/java/com/java110/code/GeneratorSaveInfoListener.java

@@ -42,6 +42,9 @@ public class GeneratorSaveInfoListener extends BaseGenerator {
         String tmpLine = "";
         String _tmpLine ="";
         for(String key : tmpParams.keySet()){
+            if("operate".equals(key) || "statusCd".equals(key) || "bId".equals(key)){
+                continue;
+            }
             tmpLine += "|business"+toUpperCaseFirstOne(data.getName())+"Info|"+key+"|1|String|30|-|-|\n";
             _tmpLine += "        \""+key+"\":\"填写具体值\",\n";
         }

+ 34 - 0
java110-code-generator/src/main/java/com/java110/code/GeneratorUpdateInfoListener.java

@@ -1,5 +1,7 @@
 package com.java110.code;
 
+import java.util.Map;
+
 /**
  * 更新类 代码生成器
  */
@@ -24,5 +26,37 @@ public class GeneratorUpdateInfoListener extends BaseGenerator {
                 + "/Update" + toUpperCaseFirstOne(data.getName()) + "InfoListener.java";
         writeFile(writePath,
                 fileContext);
+
+
+        //生成协议
+
+        /**
+         * |businessstoreMember|memberTypeCd|1|String|30|成员类型|成员类型|
+         */
+        StringBuffer sbDoc = readFile(this.getClass().getResource("/template/serviceDoc.txt").getFile());
+        String fileContextDoc = sbDoc.toString();
+        fileContextDoc = fileContextDoc.replace("store",toLowerCaseFirstOne(data.getName()))
+                .replace("Store",toUpperCaseFirstOne(data.getName()))
+                .replace("商户",data.getDesc())
+                .replace("保存","修改")
+                .replace("$businessTypeCd$",data.getUpdateBusinessTypeCdValue());
+
+        Map<String,String> tmpParams = data.getParams();
+        String tmpLine = "";
+        String _tmpLine ="";
+        for(String key : tmpParams.keySet()){
+            if("operate".equals(key) || "statusCd".equals(key) || "bId".equals(key)){
+                continue;
+            }
+            tmpLine += "|business"+toUpperCaseFirstOne(data.getName())+"Info|"+key+"|1|String|30|-|-|\n";
+            _tmpLine += "        \""+key+"\":\"填写具体值\",\n";
+        }
+        _tmpLine = _tmpLine.substring(0,_tmpLine.lastIndexOf(","));
+        fileContextDoc = fileContextDoc.replace("$busienssInfo$",tmpLine);
+        fileContextDoc = fileContextDoc.replace("$businessInfoJson$",_tmpLine);
+        System.out.println(this.getClass().getResource("/listener").getPath());
+        String writePathDoc = this.getClass().getResource("/listener").getPath()+"/Update"+toUpperCaseFirstOne(data.getName())+"Info.md";
+        writeFile(writePathDoc,
+                fileContextDoc);
     }
 }