From 56087f0d8419d5cd5c1fa2835657ea07f5748afe Mon Sep 17 00:00:00 2001
From: Your Name <you@example.com>
Date: 星期三, 25 一月 2023 16:07:45 +0800
Subject: [PATCH] 加入 业主相关接口的文档
---
service-user/src/main/java/com/java110/user/cmd/owner/EditOwnerCmd.java | 46 ++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 46 insertions(+), 0 deletions(-)
diff --git a/service-user/src/main/java/com/java110/user/cmd/owner/EditOwnerCmd.java b/service-user/src/main/java/com/java110/user/cmd/owner/EditOwnerCmd.java
index 765a6eb..0569185 100644
--- a/service-user/src/main/java/com/java110/user/cmd/owner/EditOwnerCmd.java
+++ b/service-user/src/main/java/com/java110/user/cmd/owner/EditOwnerCmd.java
@@ -8,6 +8,7 @@
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.owner.OwnerAppUserDto;
@@ -33,6 +34,51 @@
import java.util.List;
+@Java110CmdDoc(title = "淇敼涓氫富",
+ description = "绗笁鏂圭郴缁燂紝姣斿鎷涘晢绯荤粺鍚屾涓氫富淇℃伅",
+ httpMethod = "post",
+ url = "http://{ip}:{port}/app/owner.editOwner",
+ resource = "userDoc",
+ author = "鍚村鏂�",
+ serviceCode = "owner.editOwner"
+)
+
+@Java110ParamsDoc(params = {
+ @Java110ParamDoc(name = "communityId", length = 30, remark = "灏忓尯ID"),
+ @Java110ParamDoc(name = "name", length = 64, remark = "涓氫富鍚嶇О"),
+ @Java110ParamDoc(name = "link", length = 11, remark = "涓氫富鎵嬫満鍙�"),
+ @Java110ParamDoc(name = "idCard", length = 30, remark = "涓氫富韬唤璇佸彿"),
+ @Java110ParamDoc(name = "address", length = 512, remark = "鍦板潃"),
+ @Java110ParamDoc(name = "sex", length = 12, remark = "鎬у埆 鐢� 1 濂� 0"),
+ @Java110ParamDoc(name = "ownerTypeCd", length = 12, remark = "涓氫富绫诲瀷 1001 涓氫富 2002 瀹跺涵鎴愬憳 瀹跺涵鎴愬憳 闇�瑕佷紶涓氫富鐨刼wnerId"),
+ @Java110ParamDoc(name = "remark", length = 512, remark = "澶囨敞"),
+ @Java110ParamDoc(name = "memberId", length = 30, remark = "涓氫富ID"),
+ @Java110ParamDoc(name = "ownerPhoto", length = -1, 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\"name\": \"鐜嬬帇\",\n" +
+ "\t\"age\": \"\",\n" +
+ "\t\"link\": \"18909718888\",\n" +
+ "\t\"address\": \"寮犱笁\",\n" +
+ "\t\"sex\": \"0\",\n" +
+ "\t\"ownerTypeCd\": \"1001\",\n" +
+ "\t\"remark\": \"\",\n" +
+ "\t\"memberId\": 123123123,\n" +
+ "\t\"ownerPhoto\": \"\",\n" +
+ "\t\"idCard\": \"\",\n" +
+ "\t\"communityId\": \"2022121921870161\"\n" +
+ "}",
+ resBody="{\"code\":0,\"msg\":\"鎴愬姛\"}"
+)
@Java110Cmd(serviceCode = "owner.editOwner")
public class EditOwnerCmd extends Cmd {
--
Gitblit v1.8.0