Browse Source

加入房屋相关的接口文档

Your Name 3 years ago
parent
commit
f3f35802d2

+ 1 - 1
service-acct/src/main/java/com/java110/acct/cmd/couponProperty/GeneratorCouponQrcodeCmd.java

@@ -24,7 +24,7 @@ import java.util.List;
 
 
 
-@Java110CmdDoc(title = "生成核销码",
+@Java110CmdDoc(title = "优惠券核销码",
         description = "供业主端生成优惠券核销码",
         httpMethod = "post",
         url = "http://{ip}:{port}/app/couponProperty.generatorCouponQrcode",

+ 29 - 0
service-community/src/main/java/com/java110/community/cmd/room/DeleteRoomCmd.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.UnitDto;
 import com.java110.intf.community.*;
 import com.java110.po.room.RoomPo;
@@ -17,6 +18,34 @@ import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.List;
 
+@Java110CmdDoc(title = "删除房屋",
+        description = "对应后台 删除房屋功能,这里需要先解绑业主和房屋关系 才能做删除",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/room.deleteRoom",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "room.deleteRoom"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "roomId", 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="{\n" +
+                "\t\"roomId\": \"123123123123\",\n" +
+                "\t\"communityId\": \"2022121921870161\",\n" +
+                "}",
+        resBody="{\"code\":0,\"msg\":\"成功\"}"
+)
 @Java110Cmd(serviceCode = "room.deleteRoom")
 public class DeleteRoomCmd extends Cmd {
 

+ 1 - 1
service-community/src/main/java/com/java110/community/cmd/room/ExitRoomCmd.java

@@ -30,7 +30,7 @@ import java.util.List;
         description = "对应后台 业主退房房屋功能",
         httpMethod = "post",
         url = "http://{ip}:{port}/app/room.exitRoom",
-        resource = "roomDoc",
+        resource = "communityDoc",
         author = "吴学文",
         serviceCode = "room.exitRoom"
 )

+ 55 - 0
service-community/src/main/java/com/java110/community/cmd/room/SaveRoomCmd.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.RoomDto;
 import com.java110.dto.UnitDto;
 import com.java110.intf.community.IRoomV1InnerServiceSMO;
@@ -21,6 +22,60 @@ import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.List;
 
+
+@Java110CmdDoc(title = "添加房屋",
+        description = "对应后台 添加房屋功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/room.saveRoom",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "room.saveRoom"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "roomNum", length = 64, remark = "房号"),
+        @Java110ParamDoc(name = "layer", length = 12, remark = "层数"),
+        @Java110ParamDoc(name = "unitId", length = 30, remark = "单元ID"),
+        @Java110ParamDoc(name = "section", length = 12, remark = "房屋个数"),
+        @Java110ParamDoc(name = "apartment", length = 12, remark = "固定 10102"),
+        @Java110ParamDoc(name = "builtUpArea", length = 12, remark = "建筑面积"),
+        @Java110ParamDoc(name = "feeCoefficient", length = 12, remark = "算费系数 固定1"),
+        @Java110ParamDoc(name = "state", length = 12, remark = "状态 2002\t未销售"),
+        @Java110ParamDoc(name = "roomSubType", length = 12, remark = "房屋类型 110\t住宅\n" +
+                "120\t办公室\n" +
+                "119\t宿舍"),
+        @Java110ParamDoc(name = "roomArea", length = 12, remark = "室内面积"),
+        @Java110ParamDoc(name = "roomRent", length = 12, remark = "办公室 或者宿舍 时租金"),
+        @Java110ParamDoc(name = "remark", length = 512, 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="{\n" +
+                "\t\"roomNum\": \"88488\",\n" +
+                "\t\"layer\": \"1\",\n" +
+                "\t\"unitId\":\"123123123\",\n" +
+                "\t\"section\": \"0\",\n" +
+                "\t\"apartment\": \"10102\",\n" +
+                "\t\"builtUpArea\": \"110\",\n" +
+                "\t\"feeCoefficient\": \"1.00\",\n" +
+                "\t\"state\": \"2002\",\n" +
+                "\t\"remark\": \"sdf\",\n" +
+                "\t\"roomSubType\": \"110\",\n" +
+                "\t\"roomArea\": \"110\",\n" +
+                "\t\"roomRent\": \"0\",\n" +
+                "\t\"communityId\": \"2022121921870161\",\n" +
+                "}",
+        resBody="{\"code\":0,\"msg\":\"成功\"}"
+)
+
 @Java110Cmd(serviceCode = "room.saveRoom")
 public class SaveRoomCmd extends Cmd {
 

+ 1 - 1
service-community/src/main/java/com/java110/community/cmd/room/SellRoomCmd.java

@@ -25,7 +25,7 @@ import java.text.ParseException;
         description = "对应后台 业主入驻房屋功能",
         httpMethod = "post",
         url = "http://{ip}:{port}/app/room.sellRoom",
-        resource = "roomDoc",
+        resource = "communityDoc",
         author = "吴学文",
         serviceCode = "room.sellRoom"
 )

+ 54 - 0
service-community/src/main/java/com/java110/community/cmd/room/UpdateRoomCmd.java

@@ -8,6 +8,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.UnitDto;
 import com.java110.dto.owner.OwnerRoomRelDto;
 import com.java110.intf.community.*;
@@ -25,6 +26,59 @@ import org.springframework.beans.factory.annotation.Autowired;
 import java.util.Date;
 import java.util.List;
 
+
+@Java110CmdDoc(title = "修改房屋",
+        description = "对应后台 修改房屋功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/room.updateRoom",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "room.updateRoom"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "roomNum", length = 64, remark = "房号"),
+        @Java110ParamDoc(name = "layer", length = 12, remark = "层数"),
+        @Java110ParamDoc(name = "unitId", length = 30, remark = "单元ID"),
+        @Java110ParamDoc(name = "roomId", length = 30, remark = "单元ID"),
+        @Java110ParamDoc(name = "section", length = 12, remark = "房屋个数"),
+        @Java110ParamDoc(name = "apartment", length = 12, remark = "固定 10102"),
+        @Java110ParamDoc(name = "builtUpArea", length = 12, remark = "建筑面积"),
+        @Java110ParamDoc(name = "feeCoefficient", length = 12, remark = "算费系数 固定1"),
+        @Java110ParamDoc(name = "roomSubType", length = 12, remark = "房屋类型 110\t住宅\n" +
+                "120\t办公室\n" +
+                "119\t宿舍"),
+        @Java110ParamDoc(name = "roomArea", length = 12, remark = "室内面积"),
+        @Java110ParamDoc(name = "roomRent", length = 12, remark = "办公室 或者宿舍 时租金"),
+        @Java110ParamDoc(name = "remark", length = 512, 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="{\n" +
+                "\t\"roomNum\": \"88488\",\n" +
+                "\t\"layer\": \"1\",\n" +
+                "\t\"unitId\":\"123123123\",\n" +
+                "\t\"section\": \"0\",\n" +
+                "\t\"apartment\": \"10102\",\n" +
+                "\t\"builtUpArea\": \"110\",\n" +
+                "\t\"feeCoefficient\": \"1.00\",\n" +
+                "\t\"roomId\": \"123123123123\",\n" +
+                "\t\"remark\": \"sdf\",\n" +
+                "\t\"roomSubType\": \"110\",\n" +
+                "\t\"roomArea\": \"110\",\n" +
+                "\t\"roomRent\": \"0\",\n" +
+                "\t\"communityId\": \"2022121921870161\",\n" +
+                "}",
+        resBody="{\"code\":0,\"msg\":\"成功\"}"
+)
 @Java110Cmd(serviceCode = "room.updateRoom")
 public class UpdateRoomCmd extends Cmd {