Просмотр исходного кода

加入房屋相关的接口文档

Your Name лет назад: 3
Родитель
Сommit
4538cf1940

+ 33 - 2
service-community/src/main/java/com/java110/community/cmd/room/ExitRoomCmd.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.RoomDto;
 import com.java110.dto.owner.OwnerRoomRelDto;
 import com.java110.intf.community.ICommunityInnerServiceSMO;
@@ -25,6 +26,36 @@ import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.List;
 
+@Java110CmdDoc(title = "业主房屋关系解绑",
+        description = "对应后台 业主退房房屋功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/room.exitRoom",
+        resource = "roomDoc",
+        author = "吴学文",
+        serviceCode = "room.exitRoom"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "roomId", length = 30, remark = "房屋ID"),
+        @Java110ParamDoc(name = "ownerId", 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\"ownerId\": 121231,\n" +
+                "\t\"roomId\": \"123123\",\n" +
+                "\t\"communityId\": \"2022121921870161\"\n" +
+                "}",
+        resBody="{\"code\":0,\"msg\":\"成功\"}"
+)
 @Java110Cmd(serviceCode = "room.exitRoom")
 public class ExitRoomCmd extends Cmd {
 
@@ -53,13 +84,13 @@ public class ExitRoomCmd extends Cmd {
         Assert.jsonObjectHaveKey(reqJson, "communityId", "请求报文中未包含communityId节点");
         Assert.jsonObjectHaveKey(reqJson, "ownerId", "请求报文中未包含ownerId节点");
         Assert.jsonObjectHaveKey(reqJson, "roomId", "请求报文中未包含roomId节点");
-        Assert.jsonObjectHaveKey(reqJson, "storeId", "请求报文中未包含storeId节点");
+        //Assert.jsonObjectHaveKey(reqJson, "storeId", "请求报文中未包含storeId节点");
 
 
         Assert.hasLength(reqJson.getString("communityId"), "小区ID不能为空");
         Assert.hasLength(reqJson.getString("ownerId"), "ownerId不能为空");
         Assert.hasLength(reqJson.getString("roomId"), "roomId不能为空");
-        Assert.hasLength(reqJson.getString("storeId"), "storeId不能为空");
+        //Assert.hasLength(reqJson.getString("storeId"), "storeId不能为空");
     }
 
     @Override

Разница между файлами не показана из-за своего большого размера
+ 31 - 0
service-community/src/main/java/com/java110/community/cmd/room/QueryRoomsByOwnerCmd.java


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

@@ -6,6 +6,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.intf.community.ICommunityInnerServiceSMO;
 import com.java110.intf.community.IRoomV1InnerServiceSMO;
 import com.java110.intf.community.IUnitInnerServiceSMO;
@@ -20,7 +21,43 @@ import com.java110.utils.util.DateUtil;
 import org.springframework.beans.factory.annotation.Autowired;
 
 import java.text.ParseException;
-
+@Java110CmdDoc(title = "业主房屋关系绑定",
+        description = "对应后台 业主入驻房屋功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/room.sellRoom",
+        resource = "roomDoc",
+        author = "吴学文",
+        serviceCode = "room.sellRoom"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "roomId", length = 30, remark = "房屋ID"),
+        @Java110ParamDoc(name = "state", length = 12, remark = "状态 2001\t已入住\t\n" +
+                "2003\t已交房\t\n" +
+                "2005\t已装修\t\n" +
+                "2004\t未入住\t\n" +
+                "2008\t空闲\n" +
+                "2009\t装修中\t"),
+        @Java110ParamDoc(name = "ownerId", 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\"ownerId\": 121231,\n" +
+                "\t\"state\": \"2001\",\n" +
+                "\t\"roomId\": \"123123\",\n" +
+                "\t\"communityId\": \"2022121921870161\"\n" +
+                "}",
+        resBody="{\"code\":0,\"msg\":\"成功\"}"
+)
 @Java110Cmd(serviceCode = "room.sellRoom")
 public class SellRoomCmd extends Cmd {
 
@@ -43,7 +80,7 @@ public class SellRoomCmd extends Cmd {
         Assert.jsonObjectHaveKey(reqJson, "ownerId", "请求报文中未包含ownerId节点");
         Assert.jsonObjectHaveKey(reqJson, "roomId", "请求报文中未包含roomId节点");
         Assert.jsonObjectHaveKey(reqJson, "state", "请求报文中未包含state节点");
-        Assert.jsonObjectHaveKey(reqJson, "storeId", "请求报文中未包含storeId节点");
+      //  Assert.jsonObjectHaveKey(reqJson, "storeId", "请求报文中未包含storeId节点");
 
         Assert.hasLength(reqJson.getString("communityId"), "小区ID不能为空");
         Assert.hasLength(reqJson.getString("ownerId"), "ownerId不能为空");