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/QueryOwnersCmd.java | 61 ++++++++++++++++++++++++++++++
1 files changed, 61 insertions(+), 0 deletions(-)
diff --git a/service-user/src/main/java/com/java110/user/cmd/owner/QueryOwnersCmd.java b/service-user/src/main/java/com/java110/user/cmd/owner/QueryOwnersCmd.java
index cfa45c4..5f3346a 100644
--- a/service-user/src/main/java/com/java110/user/cmd/owner/QueryOwnersCmd.java
+++ b/service-user/src/main/java/com/java110/user/cmd/owner/QueryOwnersCmd.java
@@ -5,6 +5,7 @@
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.basePrivilege.BasePrivilegeDto;
import com.java110.dto.file.FileRelDto;
@@ -27,6 +28,66 @@
import java.util.List;
import java.util.Map;
+@Java110CmdDoc(title = "鏌ヨ涓氫富",
+ description = "绗笁鏂圭郴缁燂紝姣斿鎷涘晢绯荤粺鏌ヨ涓氫富淇℃伅",
+ httpMethod = "get",
+ url = "http://{ip}:{port}/app/owner.queryOwners",
+ resource = "userDoc",
+ author = "鍚村鏂�",
+ serviceCode = "owner.queryOwners"
+)
+
+@Java110ParamsDoc(params = {
+ @Java110ParamDoc(name = "page", type = "int",length = 11, remark = "椤垫暟"),
+ @Java110ParamDoc(name = "row", type = "int",length = 11, remark = "琛屾暟"),
+ @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 = "ownerTypeCd", length = 12, remark = "涓氫富绫诲瀷 1001 涓氫富 2002 瀹跺涵鎴愬憳 瀹跺涵鎴愬憳 闇�瑕佷紶涓氫富鐨刼wnerId"),
+ @Java110ParamDoc(name = "ownerId", length = 30, remark = "涓氫富ID锛屽搴垚鍛樹笟涓籌D"),
+ @Java110ParamDoc(name = "memberId", length = 30, remark = "涓氫富ID锛屼富閿甀D"),
+})
+
+@Java110ResponseDoc(
+ params = {
+ @Java110ParamDoc(name = "code", type = "int", length = 11, defaultValue = "0", remark = "杩斿洖缂栧彿锛�0 鎴愬姛 鍏朵粬澶辫触"),
+ @Java110ParamDoc(name = "msg", type = "String", length = 250, defaultValue = "鎴愬姛", remark = "鎻忚堪"),
+ @Java110ParamDoc(name = "owners", type = "Array", length = -1, defaultValue = "鎴愬姛", remark = "鏁版嵁"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "communityId", length = 30, remark = "灏忓尯ID"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "name", length = 64, remark = "涓氫富鍚嶇О"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "link", length = 11, remark = "涓氫富鎵嬫満鍙�"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "idCard", length = 30, remark = "涓氫富韬唤璇佸彿"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "address", length = 512, remark = "鍦板潃"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "sex", length = 12, remark = "鎬у埆 鐢� 1 濂� 0"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "ownerTypeCd", length = 12, remark = "涓氫富绫诲瀷 1001 涓氫富 2002 瀹跺涵鎴愬憳 瀹跺涵鎴愬憳 闇�瑕佷紶涓氫富鐨刼wnerId"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "remark", length = 512, remark = "澶囨敞"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "memberId", length = 30, remark = "涓氫富ID"),
+ @Java110ParamDoc(parentNodeName = "owners",name = "ownerPhoto", length = -1, remark = "涓氫富浜鸿劯 鐢ㄤ簬鍚屾闂ㄧ 浜鸿劯寮�闂�"),
+ }
+)
+
+@Java110ExampleDoc(
+ reqBody="http://ip:port/app/owner.queryOwners?ownerTypeCd=1001&page=1&row=10&communityId=2022121921870161",
+ resBody="{\n" +
+ "\t\"owners\": [{\n" +
+ "\t\t\"address\": \"寮犱笁\",\n" +
+ "\t\t\"idCard\": \"\",\n" +
+ "\t\t\"link\": \"18909718888\",\n" +
+ "\t\t\"memberId\": \"772023012589770046\",\n" +
+ "\t\t\"name\": \"鐜嬬帇\",\n" +
+ "\t\t\"ownerId\": \"772023012589770046\",\n" +
+ "\t\t\"ownerTypeCd\": \"1001\",\n" +
+ "\t\t\"remark\": \"\",\n" +
+ "\t\t\"sex\": \"0\",\n" +
+ "\t\t\"userName\": \"浜哄拰鐗╀笟\"\n" +
+ "\t}],\n" +
+ "\t\"page\": 0,\n" +
+ "\t\"records\": 1,\n" +
+ "\t\"rows\": 0,\n" +
+ "\t\"total\": 1\n" +
+ "}"
+)
@Java110Cmd(serviceCode = "owner.queryOwners")
public class QueryOwnersCmd extends Cmd {
--
Gitblit v1.8.0