From 0abd0924f29af225ec3d90d7ad63f9560f9846dc Mon Sep 17 00:00:00 2001
From: java110 <928255095@qq.com>
Date: 星期六, 17 九月 2022 13:27:19 +0800
Subject: [PATCH] 优化 文档生成功能
---
service-user/src/main/java/com/java110/user/cmd/login/PcUserLoginCmd.java | 35 ++++++++++++++++++++++++++++++++---
1 files changed, 32 insertions(+), 3 deletions(-)
diff --git a/service-user/src/main/java/com/java110/user/cmd/login/PcUserLoginCmd.java b/service-user/src/main/java/com/java110/user/cmd/login/PcUserLoginCmd.java
index 249c56b..3c4ac29 100644
--- a/service-user/src/main/java/com/java110/user/cmd/login/PcUserLoginCmd.java
+++ b/service-user/src/main/java/com/java110/user/cmd/login/PcUserLoginCmd.java
@@ -7,6 +7,8 @@
import com.java110.core.event.cmd.CmdEvent;
import com.java110.core.factory.AuthenticationFactory;
import com.java110.core.factory.GenerateCodeFactory;
+import com.java110.core.log.LoggerFactory;
+import com.java110.doc.annotation.*;
import com.java110.dto.store.StoreUserDto;
import com.java110.dto.user.UserDto;
import com.java110.dto.userLogin.UserLoginDto;
@@ -22,19 +24,46 @@
import com.java110.utils.util.BeanConvertUtil;
import com.java110.utils.util.DateUtil;
import org.slf4j.Logger;
-import com.java110.core.log.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import java.text.ParseException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
- * 淇濆瓨缂栫爜鏄犲皠澶勭悊绫�
+ * 鐢ㄦ埛鐧诲綍 鍔熻兘
+ * 璇锋眰鍦板潃涓�/app/login.pcUserLogin
*/
+
+@Java110CmdDoc(title = "鐢ㄦ埛鐧诲綍",
+ description = "鐧诲綍鍔熻兘 涓昏鐢ㄤ簬 鍛樺伐 鎴栬�呯鐞嗗憳鐧诲綍浣跨敤",
+ httpMethod = "post",
+ url = "/app/login.pcUserLogin",
+ resource = "user",
+ author = "鍚村鏂�"
+)
+
+@Java110ParamsDoc(params = {
+ @Java110ParamDoc(name = "username", length = 30, remark = "鐢ㄦ埛鍚嶏紝鐗╀笟绯荤粺鍒嗛厤"),
+ @Java110ParamDoc(name = "passwd", length = 30, remark = "瀵嗙爜锛岀墿涓氱郴缁熷垎閰�"),
+})
+
+@Java110ResponseDoc(
+ params = {
+ @Java110ParamDoc(name = "code", type = "int", length = 11, defaultValue = "0", remark = "杩斿洖缂栧彿锛�0 鎴愬姛 鍏朵粬澶辫触"),
+ @Java110ParamDoc(name = "msg", type = "String", length = 250, defaultValue = "鎴愬姛", remark = "鎻忚堪"),
+ @Java110ParamDoc(name = "data", type = "Object", remark = "鏈夋晥鏁版嵁"),
+ @Java110ParamDoc(parentNodeName = "data",name = "userId", type = "String", remark = "鐢ㄦ埛ID"),
+ @Java110ParamDoc(parentNodeName = "data",name = "token", type = "String", remark = "涓存椂绁ㄦ嵁"),
+ }
+)
+
+@Java110ExampleDoc(
+ reqBody="{'username':'wuxw','passwd':'admin'}",
+ resBody="{'code':0,'msg':'鎴愬姛','data':{'userId':'123123','token':'123213'}}"
+)
@Java110Cmd(serviceCode = "login.pcUserLogin")
public class PcUserLoginCmd extends Cmd {
private final static Logger logger = LoggerFactory.getLogger(PcUserLoginCmd.class);
--
Gitblit v1.8.0