Explorar el Código

加入单元相关 接口文档

wuxw hace 3 años
padre
commit
7244803616

+ 28 - 0
service-user/src/main/java/com/java110/user/cmd/user/ResetStaffPwdCmd.java

@@ -8,6 +8,7 @@ import com.java110.core.event.cmd.Cmd;
 import com.java110.core.event.cmd.CmdEvent;
 import com.java110.core.factory.AuthenticationFactory;
 import com.java110.core.factory.GenerateCodeFactory;
+import com.java110.doc.annotation.*;
 import com.java110.dto.store.StoreDto;
 import com.java110.dto.store.StoreUserDto;
 import com.java110.dto.user.UserDto;
@@ -25,6 +26,33 @@ import org.springframework.http.ResponseEntity;
 
 import java.util.List;
 
+
+@Java110CmdDoc(title = "重置密码",
+        description = "外部系统通过重置员工接口 重置员工密码,注意需要物业管理员账号登录,因为不需要传storeId 是根据管理员登录信息获取的",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/user.resetStaffPwd",
+        resource = "userDoc",
+        author = "吴学文",
+        serviceCode = "user.resetStaffPwd"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "staffId", 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 = "描述"),
+                @Java110ParamDoc(name = "pwd", type = "String", length = 250,  remark = "密码"),
+        }
+)
+
+@Java110ExampleDoc(
+        reqBody="{staffId: \"302022081831710053\"}",
+        resBody="{\"msg\":\"成功\",\"code\":0,\"pwd\":\"004117\"}"
+)
+
 @Java110Cmd(serviceCode = "user.resetStaffPwd")
 public class ResetStaffPwdCmd extends Cmd {
 

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 2 - 2
service-user/src/main/java/com/java110/user/cmd/user/UserStaffAddCmd.java


+ 27 - 0
service-user/src/main/java/com/java110/user/cmd/user/UserStaffDeleteCmd.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.privilegeUser.PrivilegeUserDto;
 import com.java110.dto.repair.RepairTypeUserDto;
 import com.java110.intf.community.IRepairTypeUserInnerServiceSMO;
@@ -24,6 +25,32 @@ import org.springframework.beans.factory.annotation.Autowired;
 import java.text.ParseException;
 import java.util.List;
 
+
+@Java110CmdDoc(title = "删除员工",
+        description = "外部系统通过删除员工接口 删除员工 注意需要物业管理员账号登录,因为不需要传storeId 是根据管理员登录信息获取的",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/user.staff.delete",
+        resource = "userDoc",
+        author = "吴学文",
+        serviceCode = "user.staff.delete"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "userId", 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="{\"userId\":\"123123\"}",
+        resBody="{'code':0,'msg':'成功'"
+)
+
 @Java110Cmd(serviceCode = "user.staff.delete")
 public class UserStaffDeleteCmd extends Cmd {
 

+ 35 - 0
service-user/src/main/java/com/java110/user/cmd/user/UserStaffModifyCmd.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.file.FileDto;
 import com.java110.dto.file.FileRelDto;
 import com.java110.dto.org.OrgStaffRelDto;
@@ -31,6 +32,40 @@ import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.List;
 
+
+@Java110CmdDoc(title = "修改员工",
+        description = "外部系统通过修改员工接口 修改员工,注意需要物业管理员账号登录,因为不需要传storeId 是根据管理员登录信息获取的",
+        httpMethod = "post",
+        url = "http://{ip}:{port}/app/user.staff.modify",
+        resource = "userDoc",
+        author = "吴学文",
+        serviceCode = "user.staff.modify"
+)
+
+@Java110ParamsDoc(params = {
+        @Java110ParamDoc(name = "userId", length = 30, remark = "员工ID"),
+        @Java110ParamDoc(name = "orgId", length = 30, remark = "组织ID"),
+        @Java110ParamDoc(name = "orgName", length = 64, remark = "组织名称"),
+        @Java110ParamDoc(name = "name", length = 64, remark = "名称"),
+        @Java110ParamDoc(name = "sex", length = 64, remark = "性别 0女 1男"),
+        @Java110ParamDoc(name = "email", length = 64, remark = "邮箱"),
+        @Java110ParamDoc(name = "tel", length = 11, remark = "手机号"),
+        @Java110ParamDoc(name = "address", length = 64, remark = "地址"),
+        @Java110ParamDoc(name = "relCd", length = 64, remark = "岗位,普通员工 1000 部门经理 2000 部门副经理 3000 部门组长 4000 分公司总经理 5000 分公司副总经理 6000 总经理助理 7000 总公司总经理 8000 总公司副总经理 9000"),
+})
+
+@Java110ResponseDoc(
+        params = {
+                @Java110ParamDoc(name = "code", type = "int", length = 11, defaultValue = "0", remark = "返回编号,0 成功 其他失败"),
+                @Java110ParamDoc(name = "msg", type = "String", length = 250, defaultValue = "成功", remark = "描述"),
+        }
+)
+
+@Java110ExampleDoc(
+        reqBody="{\"userId\":\"123123\",\"orgId\":\"102022091988250052\",\"orgName\":\"演示物业 / 件部\",\"username\":\"张三\",\"sex\":\"0\",\"email\":\"231@qq.com\",\"tel\":\"123\",\"address\":\"123\",\"relCd\":\"1000\",\"photo\":\"\",\"name\":\"张三\"}",
+        resBody="{'code':0,'msg':'成功'"
+)
+
 @Java110Cmd(serviceCode = "user.staff.modify")
 public class UserStaffModifyCmd extends Cmd {