[增加]1. 增加接口和字段和类型的描述

Author: AlianBlank

GameFrameX.Hotfix/GlobalUsings.cs

@@ -13,4 +13,5 @@
 global using GameFrameX.Core.Timer;
 global using GameFrameX.Utility;
 global using GameFrameX.GameAnalytics;
-global using GameFrameX.Core.Components;
+global using GameFrameX.Core.Components;
+global using System.ComponentModel;

GameFrameX.Hotfix/Logic/Http/GetOnlinePlayerHttpHandler.cs

@@ -9,6 +9,9 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// http://localhost:20001/game/api/GetOnlinePlayer
 /// </summary>
 [HttpMessageMapping(typeof(GetOnlinePlayerHttpHandler))]
+[HttpMessageRequest(typeof(GetOnlinePlayerRequest))]
+[HttpMessageResponse(typeof(GetOnlinePlayerResponse))]
+[Description("获取在线人数")]
 public sealed class GetOnlinePlayerHttpHandler : BaseHttpHandler
 {
     /// <summary>
@@ -24,9 +27,24 @@ public override Task<string> Action(string ip, string url, Dictionary<string, ob
         var res = HttpJsonResult.SuccessString(response);
         return Task.FromResult(res);
     }
+}
 
-    private class GetOnlinePlayerResponse
-    {
-        public int Count { get; set; }
-    }
+/// <summary>
+/// 获取在线人数请求
+/// </summary>
+public sealed class GetOnlinePlayerRequest : HttpMessageRequestBase
+{
+    // 空请求
+}
+
+/// <summary>
+/// 获取在线人数响应
+/// </summary>
+public sealed class GetOnlinePlayerResponse : HttpMessageResponseBase
+{
+    /// <summary>
+    /// 在线人数
+    /// </summary>
+    [Description("当前在线玩家数量")]
+    public int Count { get; set; }
 }

GameFrameX.Hotfix/Logic/Http/GetOnlinePlayerListHttpHandler.cs

@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using GameFrameX.Apps.Common.Session;
 using GameFrameX.Foundation.Http.Normalization;
 using GameFrameX.NetWork.HTTP;
@@ -9,23 +10,42 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// http://localhost:20001/game/api/GetOnlinePlayerList
 /// </summary>
 [HttpMessageMapping(typeof(GetOnlinePlayerListHttpHandler))]
+[HttpMessageRequest(typeof(GetOnlinePlayerListRequest))]
+[HttpMessageResponse(typeof(GetOnlinePlayerListResponse))]
+[Description("获取在线玩家列表")]
 public sealed class GetOnlinePlayerListHttpHandler : BaseHttpHandler
 {
     /// <summary>
     /// </summary>
     /// <param name="ip"></param>
     /// <param name="url"></param>
-    /// <param name="parameters"></param>
+    /// <param name="request"></param>
     /// <returns></returns>
-    public override Task<string> Action(string ip, string url, Dictionary<string, object> parameters)
+    public override Task<string> Action(string ip, string url, HttpMessageRequestBase request)
     {
-        parameters.TryGetValue("pageSize", out var pageSizeStr);
-        parameters.TryGetValue("pageIndex", out var pageIndexStr);
-        var pageSize = string.IsNullOrEmpty(pageSizeStr?.ToString()) ? 0 : Convert.ToInt32(pageSizeStr);
-        var pageIndex = string.IsNullOrEmpty(pageIndexStr?.ToString()) ? 0 : Convert.ToInt32(pageIndexStr);
-
-        var response = SessionManager.GetPageList(pageSize, pageIndex);
+        GetOnlinePlayerListRequest parameters = (GetOnlinePlayerListRequest)request;
+        var response = SessionManager.GetPageList(parameters.PageSize, parameters.PageIndex);
         var res = HttpJsonResult.SuccessString("当前在线玩家", JsonHelper.Serialize(response));
         return Task.FromResult(res);
     }
+}
+
+public sealed class GetOnlinePlayerListResponse : HttpMessageResponseBase
+{
+    public List<Session> List { get; set; }
+}
+
+public sealed class GetOnlinePlayerListRequest : HttpMessageRequestBase
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    [Required, Range(0, int.MaxValue)]
+    public int PageIndex { get; set; }
+
+    /// <summary>
+    /// 
+    /// </summary>
+    [Required, Range(1, int.MaxValue)]
+    public int PageSize { get; set; }
 }

GameFrameX.Hotfix/Logic/Http/KickOffLineByUserIdPlayerHttpHandler.cs

@@ -9,6 +9,7 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// http://localhost:20001/game/api/KickOffLineByUserIdPlayer
 /// </summary>
 [HttpMessageMapping(typeof(KickOffLineByUserIdPlayerHttpHandler))]
+[Description("将指定角色的玩家从当前服务断开")]
 public sealed class KickOffLineByUserIdPlayerHttpHandler : BaseHttpHandler
 {
     /// <summary>

GameFrameX.Hotfix/Logic/Http/ReloadHttpHandler.cs

@@ -8,6 +8,7 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// http://localhost:20001/game/api/Reload?version=1.0.0
 /// </summary>
 [HttpMessageMapping(typeof(ReloadHttpHandler))]
+[Description("热更新")]
 public sealed class ReloadHttpHandler : BaseHttpHandler
 {
     /// <summary>

GameFrameX.Hotfix/Logic/Http/ReqLoginHttpHandler.cs

@@ -12,6 +12,7 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// 账号登录
 /// </summary>
 [HttpMessageMapping(typeof(ReqLoginHttpHandler))]
+[Description("账号登录,仅限前端调用")]
 public sealed class ReqLoginHttpHandler : BaseHttpHandler
 {
     public override async Task<MessageObject> Action(string ip, string url, Dictionary<string, object> parameters, MessageObject messageObject)

GameFrameX.Hotfix/Logic/Http/ReqPlayerCreateHttpHandler.cs

@@ -1,8 +1,5 @@
-using GameFrameX.Apps.Account.Login.Entity;
 using GameFrameX.Apps.Player.Player.Entity;
 using GameFrameX.DataBase;
-using GameFrameX.Hotfix.Common;
-using GameFrameX.Monitor.Account;
 using GameFrameX.Monitor.Player;
 using GameFrameX.NetWork.HTTP;
 using GameFrameX.NetWork.Messages;
@@ -14,6 +11,7 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// 角色创建
 /// </summary>
 [HttpMessageMapping(typeof(ReqPlayerCreateHttpHandler))]
+[Description("角色创建,仅限前端调用")]
 public sealed class ReqPlayerCreateHttpHandler : BaseHttpHandler
 {
     public override async Task<MessageObject> Action(string ip, string url, Dictionary<string, object> paramMap, MessageObject messageObject)

GameFrameX.Hotfix/Logic/Http/ReqPlayerListHttpHandler.cs

@@ -10,6 +10,7 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// 获取角色列表
 /// </summary>
 [HttpMessageMapping(typeof(ReqPlayerListHttpHandler))]
+[Description("获取角色列表,仅限前端调用")]
 public sealed class ReqPlayerListHttpHandler : BaseHttpHandler
 {
     public override async Task<MessageObject> Action(string ip, string url, Dictionary<string, object> paramMap, MessageObject messageObject)

GameFrameX.Hotfix/Logic/Http/TestHttpHandler.cs

@@ -8,6 +8,8 @@ namespace GameFrameX.Hotfix.Logic.Http;
 /// http://localhost:20001/game/api/test
 /// </summary>
 [HttpMessageMapping(typeof(TestHttpHandler))]
+[HttpMessageResponse(typeof(HttpTestResponse))]
+[Description("测试通讯接口。没有实际用途")]
 public sealed class TestHttpHandler : BaseHttpHandler
 {
     /// <summary>
@@ -18,28 +20,15 @@ public sealed class TestHttpHandler : BaseHttpHandler
     /// <returns></returns>
     public override Task<string> Action(string ip, string url, Dictionary<string, object> parameters)
     {
-        var response = new HttpTestRes
+        var response = new HttpTestResponse
         {
-            A = 100,
-            B = "hello",
-            TestInfo = new HttpTestRes.Info(),
+            Message = "hello",
         };
-        response.TestInfo.Age = 18;
-        response.TestInfo.Name = "leeveel";
         return Task.FromResult(HttpJsonResult.SuccessString(response));
     }
+}
 
-    public class HttpTestRes
-    {
-        public int A { get; set; }
-        public string B { get; set; }
-
-        public Info TestInfo { get; set; }
-
-        public class Info
-        {
-            public int Age { get; set; }
-            public string Name { get; set; }
-        }
-    }
+public sealed class HttpTestResponse : HttpMessageResponseBase
+{
+    [Description("返回信息")] public string Message { get; set; }
 }