加入单元相关 接口文档

service-community/src/main/java/com/java110/community/cmd/unit/DeleteUnitCmd.java

@@ -6,6 +6,7 @@ import com.java110.core.annotation.Java110Transactional;
 import com.java110.core.context.ICmdDataFlowContext;
 import com.java110.core.event.cmd.Cmd;
 import com.java110.core.event.cmd.CmdEvent;
+import com.java110.doc.annotation.*;
 import com.java110.dto.FloorDto;
 import com.java110.dto.RoomDto;
 import com.java110.dto.UnitDto;
@@ -20,6 +21,34 @@ import com.java110.utils.util.BeanConvertUtil;
 import com.java110.vo.ResultVo;
 import org.springframework.beans.factory.annotation.Autowired;
 
+
+
+@Java110CmdDoc(title = "删除单元",
+        description = "用于外系统删除单元信息功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/unit.deleteUnit",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "unit.deleteUnit"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "unitId", length = 30, remark = "单元ID"),
+})
+
+@Java110ResponseDoc(
+        params = {
+                @Java110ParamDoc(name = "code", type = "int", length = 11, defaultValue = "0", remark = "返回编号，0 成功 其他失败"),
+                @Java110ParamDoc(name = "msg", type = "String", length = 250, defaultValue = "成功", remark = "描述"),
+        }
+)
+
+@Java110ExampleDoc(
+        reqBody="{\"unitId\":\"123123\",\"communityId\":\"2022081539020475\"}",
+        resBody="{'code':0,'msg':'成功'}"
+)
+
 @Java110Cmd(serviceCode = "unit.deleteUnit")
 public class DeleteUnitCmd extends Cmd {
     @Autowired

service-community/src/main/java/com/java110/community/cmd/unit/QueryUnitsCmd.java

@@ -5,6 +5,7 @@ import com.java110.core.annotation.Java110Cmd;
 import com.java110.core.context.ICmdDataFlowContext;
 import com.java110.core.event.cmd.Cmd;
 import com.java110.core.event.cmd.CmdEvent;
+import com.java110.doc.annotation.*;
 import com.java110.dto.UnitDto;
 import com.java110.dto.dataPrivilegeStaff.DataPrivilegeStaffDto;
 import com.java110.intf.community.IDataPrivilegeUnitV1InnerServiceSMO;
@@ -20,6 +21,36 @@ import org.springframework.http.ResponseEntity;
 
 import java.util.List;
 
+
+@Java110CmdDoc(title = "查询单元",
+        description = "用于外系统查询单元信息功能",
+        httpMethod = "get",
+        url = "http://{ip}:{port}/app/unit.queryUnits",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "unit.queryUnits"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "floorId", length = 30, remark = "楼栋ID"),
+        @Java110ParamDoc(name = "page", type = "int",length = 11, remark = "页数"),
+        @Java110ParamDoc(name = "row", type = "int",length = 11, remark = "行数"),
+})
+
+@Java110ResponseDoc(
+        params = {
+                @Java110ParamDoc(name = "unitId", type = "String", length = 30,  remark = "单元ID"),
+                @Java110ParamDoc(name = "unitNum",  type = "String", length = 250,  remark = "单元编号"),
+                @Java110ParamDoc(name = "seq",  type = "int", length = 11,  remark = "排序"),
+        }
+)
+
+@Java110ExampleDoc(
+        reqBody="http://{ip}:{port}/app/unit.queryUnits?page=1&row=10&communityId=123123&floorId=123",
+        resBody="{'unitId':'123123','unitNum':'123123','seq':1}"
+)
+
 @Java110Cmd(serviceCode = "unit.queryUnits")
 public class QueryUnitsCmd extends Cmd {
     @Autowired

service-community/src/main/java/com/java110/community/cmd/unit/SaveUnitCmd.java

@@ -7,6 +7,7 @@ import com.java110.core.context.ICmdDataFlowContext;
 import com.java110.core.event.cmd.Cmd;
 import com.java110.core.event.cmd.CmdEvent;
 import com.java110.core.factory.GenerateCodeFactory;
+import com.java110.doc.annotation.*;
 import com.java110.dto.FloorDto;
 import com.java110.dto.UnitDto;
 import com.java110.intf.community.IFloorInnerServiceSMO;
@@ -19,6 +20,37 @@ import com.java110.utils.util.BeanConvertUtil;
 import com.java110.vo.ResultVo;
 import org.springframework.beans.factory.annotation.Autowired;
 
+
+@Java110CmdDoc(title = "添加单元",
+        description = "用于外系统添加单元信息功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/unit.saveUnit",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "unit.saveUnit"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "floorId", length = 30, remark = "楼栋ID"),
+        @Java110ParamDoc(name = "unitNum", length = 30, remark = "单元"),
+        @Java110ParamDoc(name = "layerCount", length = 30, remark = "楼层"),
+        @Java110ParamDoc(name = "lift", length = 30, remark = "1010 有电梯 2020 无电梯"),
+        @Java110ParamDoc(name = "unitArea", length = 30, remark = "面积"),
+})
+
+@Java110ResponseDoc(
+        params = {
+                @Java110ParamDoc(name = "code", type = "int", length = 11, defaultValue = "0", remark = "返回编号，0 成功 其他失败"),
+                @Java110ParamDoc(name = "msg", type = "String", length = 250, defaultValue = "成功", remark = "描述"),
+        }
+)
+
+@Java110ExampleDoc(
+        reqBody="{\"floorId\":\"732022081690440002\",\"unitNum\":\"2\",\"layerCount\":\"2\",\"lift\":\"1010\",\"remark\":\"2\",\"communityId\":\"2022081539020475\",\"unitArea\":\"2\"}",
+        resBody="{'code':0,'msg':'成功'}"
+)
+
 @Java110Cmd(serviceCode = "unit.saveUnit")
 public class SaveUnitCmd extends Cmd {
     @Autowired

service-community/src/main/java/com/java110/community/cmd/unit/UpdateUnitCmd.java

@@ -6,6 +6,7 @@ import com.java110.core.annotation.Java110Transactional;
 import com.java110.core.context.ICmdDataFlowContext;
 import com.java110.core.event.cmd.Cmd;
 import com.java110.core.event.cmd.CmdEvent;
+import com.java110.doc.annotation.*;
 import com.java110.dto.FloorDto;
 import com.java110.dto.UnitDto;
 import com.java110.intf.community.IFloorInnerServiceSMO;
@@ -18,6 +19,38 @@ import com.java110.utils.util.BeanConvertUtil;
 import com.java110.vo.ResultVo;
 import org.springframework.beans.factory.annotation.Autowired;
 
+
+@Java110CmdDoc(title = "修改单元",
+        description = "用于外系统修改单元信息功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/unit.updateUnit",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "unit.updateUnit"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "floorId", length = 30, remark = "楼栋ID"),
+        @Java110ParamDoc(name = "unitId", length = 30, remark = "单元ID"),
+        @Java110ParamDoc(name = "unitNum", length = 30, remark = "单元"),
+        @Java110ParamDoc(name = "layerCount", length = 30, remark = "楼层"),
+        @Java110ParamDoc(name = "lift", length = 30, remark = "1010 有电梯 2020 无电梯"),
+        @Java110ParamDoc(name = "unitArea", length = 30, remark = "面积"),
+})
+
+@Java110ResponseDoc(
+        params = {
+                @Java110ParamDoc(name = "code", type = "int", length = 11, defaultValue = "0", remark = "返回编号，0 成功 其他失败"),
+                @Java110ParamDoc(name = "msg", type = "String", length = 250, defaultValue = "成功", remark = "描述"),
+        }
+)
+
+@Java110ExampleDoc(
+        reqBody="{\"floorId\":\"732022081690440002\",\"unitId\":\"123123\",\"unitNum\":\"2\",\"layerCount\":\"2\",\"lift\":\"1010\",\"remark\":\"2\",\"communityId\":\"2022081539020475\",\"unitArea\":\"2\"}",
+        resBody="{'code':0,'msg':'成功'}"
+)
+
 @Java110Cmd(serviceCode = "unit.updateUnit")
 public class UpdateUnitCmd extends Cmd {
     @Autowired

springboot/src/main/java/com/java110/boot/rest/RestApi.java

@@ -40,16 +40,16 @@ import java.util.Map;
 @Java110RequestMappingsDoc(
         mappingsDocs = {
                 @Java110RequestMappingDoc(name = "用户中心", resource = "userDoc", url = "http://127.0.0.1:8008", seq = 1, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "账户中心", resource = "acctDoc", url = "http://127.0.0.1:8008", seq = 2, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "通用中心", resource = "commonDoc", url = "http://127.0.0.1:8008", seq = 3, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "资产中心", resource = "communityDoc", url = "http://127.0.0.1:8008", seq = 4, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "开发中心", resource = "devDoc", url = "http://127.0.0.1:8008", seq = 5, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "费用中心", resource = "feeDoc", url = "http://127.0.0.1:8008", seq = 6, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "定时任务", resource = "jobDoc", url = "http://127.0.0.1:8008", seq = 7, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "oa", resource = "oaDoc", url = "http://127.0.0.1:8008", seq = 8, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "订单中心", resource = "orderDoc", url = "http://127.0.0.1:8008", seq = 9, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "报表中心", resource = "reportDoc", url = "http://127.0.0.1:8008", seq = 10, startWay = "boot"),
-                @Java110RequestMappingDoc(name = "商户中心", resource = "storeDoc", url = "http://127.0.0.1:8008", seq = 11, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "资产中心", resource = "communityDoc", url = "http://127.0.0.1:8008", seq = 2, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "商户中心", resource = "storeDoc", url = "http://127.0.0.1:8008", seq = 3, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "账户中心", resource = "acctDoc", url = "http://127.0.0.1:8008", seq = 4, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "通用中心", resource = "commonDoc", url = "http://127.0.0.1:8008", seq = 5, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "开发中心", resource = "devDoc", url = "http://127.0.0.1:8008", seq = 6, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "费用中心", resource = "feeDoc", url = "http://127.0.0.1:8008", seq = 7, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "定时任务", resource = "jobDoc", url = "http://127.0.0.1:8008", seq = 8, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "oa", resource = "oaDoc", url = "http://127.0.0.1:8008", seq = 9, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "订单中心", resource = "orderDoc", url = "http://127.0.0.1:8008", seq = 10, startWay = "boot"),
+                @Java110RequestMappingDoc(name = "报表中心", resource = "reportDoc", url = "http://127.0.0.1:8008", seq = 11, startWay = "boot"),
         }
 )
 public class RestApi extends BaseController {