Parcourir la source

加入楼栋相关 接口文档

wuxw il y a 3 ans
Parent
commit
2b52dd4345

+ 34 - 0
service-community/src/main/java/com/java110/community/cmd/floor/EditFloorCmd.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.intf.community.IFloorInnerServiceSMO;
 import com.java110.intf.community.IFloorV1InnerServiceSMO;
@@ -20,6 +21,39 @@ import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.List;
 
+
+
+@Java110CmdDoc(title = "编辑楼栋",
+        description = "用于外系统编辑楼栋信息功能",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/floor.editFloor",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "floor.editFloor"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "name", length = 64, remark = "名称"),
+        @Java110ParamDoc(name = "floorArea", length = 64, remark = "面积"),
+        @Java110ParamDoc(name = "floorNum", length = 64, remark = "编号"),
+        @Java110ParamDoc(name = "seq",type = "int",length = 11, remark = "排序"),
+        @Java110ParamDoc(name = "floorId",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="{\"floorId\":\"123123\",\"name\":\"2号楼\",\"floorName\":\"\",\"floorArea\":\"22\",\"floorNum\":\"2\",\"remark\":\"2\",\"errorInfo\":\"\",\"seq\":\"22\",\"communityId\":\"2022081539020475\"}",
+        resBody="{'code':0,'msg':'成功'}"
+)
+
+
 @Java110Cmd(serviceCode = "floor.editFloor")
 public class EditFloorCmd extends Cmd {
     @Autowired

+ 1 - 1
service-community/src/main/java/com/java110/community/cmd/floor/QueryFloorsCmd.java

@@ -46,7 +46,7 @@ import java.util.List;
 )
 
 @Java110ExampleDoc(
-        reqBody="{'username':'wuxw','passwd':'admin'}",
+        reqBody="http://{ip}:{port}/app/floor.queryFloors?page=1&row=10&communityId=123123",
         resBody="{'code':0,'msg':'成功','apiFloorDataVoList':[{'floorId':'123123','floorNum':'123213'}]}"
 )
 

+ 32 - 0
service-community/src/main/java/com/java110/community/cmd/floor/SaveFloorCmd.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.intf.community.IFloorInnerServiceSMO;
 import com.java110.intf.community.IFloorV1InnerServiceSMO;
@@ -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/floor.saveFloor",
+        resource = "communityDoc",
+        author = "吴学文",
+        serviceCode = "floor.saveFloor"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "communityId", length = 30, remark = "小区ID"),
+        @Java110ParamDoc(name = "name", length = 64, remark = "名称"),
+        @Java110ParamDoc(name = "floorArea", length = 64, remark = "面积"),
+        @Java110ParamDoc(name = "floorNum", length = 64, remark = "编号"),
+        @Java110ParamDoc(name = "seq",type = "int",length = 11, 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\":\"\",\"name\":\"2号楼\",\"floorName\":\"\",\"floorArea\":\"22\",\"floorNum\":\"2\",\"remark\":\"2\",\"errorInfo\":\"\",\"seq\":\"22\",\"communityId\":\"2022081539020475\"}",
+        resBody="{'code':0,'msg':'成功'}"
+)
+
+
 @Java110Cmd(serviceCode = "floor.saveFloor")
 public class SaveFloorCmd extends Cmd {
     @Autowired