为各服务接口补 /// 中文注释:swagger 恢复中文说明(admin 203 / user 93 / customer 12 / fishgame 4)

This commit is contained in:
2026-10-19 00:44:00 +08:00
parent ff2b779a56
commit 466a4b1cea
39 changed files with 947 additions and 6 deletions
+99
View File
@@ -37,6 +37,9 @@ namespace UserApi.Hall
}
/// <summary>
/// 存入保险箱
/// </summary>
[HttpGet("SaveSafeBox")]
public async Task<BaseResponse<string>> SaveSafeBox(int gold)
{
@@ -47,6 +50,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 取出保险箱
/// </summary>
[HttpGet("GetSafeBox")]
public async Task<BaseResponse<string>> GetSafeBox(long gold, string password)
{
@@ -57,6 +63,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 设置保险箱密码
/// </summary>
[HttpGet("SetSafeBoxPassword")]
public async Task<BaseResponse<string>> SetSafeBoxPassword(string password)
{
@@ -68,6 +77,9 @@ namespace UserApi.Hall
}
/// <summary>
/// 重设保险箱密码 - 通过短信验证码重置
/// </summary>
[HttpGet("ResetSafeBoxPassword")]
public async Task<BaseResponse<string>> ResetSafeBoxPassword(string password, string code)
{
@@ -78,6 +90,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 领取救济金
/// </summary>
[HttpGet("GetRelief")]
public async Task<BaseResponse<string>> GetRelief()
{
@@ -89,6 +104,9 @@ namespace UserApi.Hall
}
/// <summary>
/// 合成碎片
/// </summary>
[HttpGet("SynthesisFragment")]
public async Task<BaseResponse<BaseProductCount>> SynthesisFragment(string propNumber)
{
@@ -102,6 +120,9 @@ namespace UserApi.Hall
/// <summary>
/// 购买道具
/// </summary>
[HttpGet("BuyProp")]
public async Task<BaseResponse<string>> BuyProp(string propNumber, int count = 1)
{
@@ -112,6 +133,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 使用VIP经验包
/// </summary>
[HttpGet("UseVipExp")]
public async Task<BaseResponse<string>> UseVipExp(int count = 1)
{
@@ -122,6 +146,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 购买金币
/// </summary>
[HttpGet("BuyGold")]
public async Task<BaseResponse<string>> BuyGold(string number, int count = 1)
{
@@ -134,6 +161,9 @@ namespace UserApi.Hall
/// <summary>
/// 购买钻石
/// </summary>
[HttpGet("BuyDiamond")]
public async Task<BaseResponse<string>> BuyDiamond(string number, int count = 1)
{
@@ -144,6 +174,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 签到
/// </summary>
[HttpGet("SignIn")]
public async Task<BaseResponse<SignRewardResult>> SignIn()
{
@@ -154,6 +187,9 @@ namespace UserApi.Hall
return this.ToFailResult<SignRewardResult>(res.msg);
}
/// <summary>
/// 获取签到状态 - 返回当前签到进度与可领取状态
/// </summary>
[HttpGet("GetSignStatus")]
public async Task<BaseResponse<SignStatusResult>> GetSignStatus()
{
@@ -162,6 +198,9 @@ namespace UserApi.Hall
}
/// <summary>
/// 切换使用的炮台
/// </summary>
[HttpGet("ChangeCannon")]
public async Task<BaseResponse<string>> ChangeCannon(string number)
{
@@ -175,6 +214,9 @@ namespace UserApi.Hall
/// <summary>
/// 切换使用的翅膀
/// </summary>
[HttpGet("ChangeWing")]
public async Task<BaseResponse<string>> ChangeWing(string number)
{
@@ -185,6 +227,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 切换使用的战神
/// </summary>
[HttpGet("ChangeGodWar")]
public async Task<BaseResponse<string>> ChangeGodWar(string number)
{
@@ -195,6 +240,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 卸载当前使用的炮台并切换为默认基础炮台(不会删除已拥有的炮台)
/// </summary>
[HttpGet("UnloadCannon")]
public async Task<BaseResponse<string>> UnloadCannon(string number)
{
@@ -205,6 +253,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 卸载当前使用的翅膀(不会删除已拥有的翅膀)
/// </summary>
[HttpGet("UnloadWing")]
public async Task<BaseResponse<string>> UnloadWing(string number)
{
@@ -215,6 +266,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(res.msg);
}
/// <summary>
/// 卸载当前使用的战神(不会删除已拥有的战神)
/// </summary>
[HttpGet("UnloadGodWar")]
public async Task<BaseResponse<string>> UnloadGodWar(string number)
{
@@ -227,6 +281,9 @@ namespace UserApi.Hall
/// <summary>
/// 领取Vip每日礼包
/// </summary>
[HttpGet("GetVipDayGift")]
public async Task<BaseResponse<GiftResponse>> GetVipDayGift()
{
@@ -238,6 +295,9 @@ namespace UserApi.Hall
}
/// <summary>
/// 领取Vip权益
/// </summary>
[HttpGet("GetVipGift")]
public async Task<BaseResponse<GiftResponse>> GetVipGift(int vipLevel)
{
@@ -251,6 +311,9 @@ namespace UserApi.Hall
/// <summary>
/// 获取用户任务列表
/// </summary>
[HttpGet("GetUserTaskList")]
[Authorize]
public async Task<ListResponse<UserTaskDto>> GetUserTaskList(int taskType)
@@ -282,6 +345,9 @@ namespace UserApi.Hall
Exp = entity.Exp
};
}
/// <summary>
/// 领取任务奖励
/// </summary>
[HttpGet("DistributeRewards")]
public async Task<BaseResponse<string>> DistributeRewards(string id)
{
@@ -292,6 +358,9 @@ namespace UserApi.Hall
return this.ToFailResult<string>(result.msg);
}
/// <summary>
/// 获取资产变动记录
/// </summary>
[HttpPost("GetUserRewardList")]
public async Task<PageResponse<UserRewardDto>> GetUserRewardList(GetUserRewardListParam param)
{
@@ -368,6 +437,9 @@ namespace UserApi.Hall
/// <summary>
/// 获取用户战令信息
/// </summary>
[HttpGet("GetBattleOrder")]
public async Task<BaseResponse<BattleOrderResponse>> GetBattleOrder()
{
@@ -375,6 +447,9 @@ namespace UserApi.Hall
return this.ToResult(result);
}
/// <summary>
/// 获取各等级奖励领取状态
/// </summary>
[HttpGet("GetBattleOrderLevelStatus")]
public async Task<BaseResponse<BattleOrderLevelStatusResponse>> GetBattleOrderLevelStatus()
{
@@ -382,6 +457,9 @@ namespace UserApi.Hall
return this.ToResult(result);
}
/// <summary>
/// 一键领取战令奖励
/// </summary>
[HttpGet("ReceiveAllBattleOrderRewards")]
public async Task<ListResponse<GiftConfig>> ReceiveAllBattleOrderRewards()
{
@@ -392,6 +470,9 @@ namespace UserApi.Hall
return this.ToListFailResult<GiftConfig>(result.message);
}
/// <summary>
/// 领取指定等级战令奖励
/// </summary>
[HttpGet("ReceiveBattleOrderLevelReward")]
public async Task<ListResponse<GiftConfig>> ReceiveBattleOrderLevelReward( int level)
{
@@ -402,6 +483,9 @@ namespace UserApi.Hall
return this.ToListFailResult<GiftConfig>(result.message);
}
/// <summary>
/// 购买战令等级
/// </summary>
[HttpGet("BuyBattleOrderLevel")]
public async Task<BaseResponse<BuyBattleOrderLevelResponse>> BuyBattleOrderLevel(int levelCount)
{
@@ -416,6 +500,9 @@ namespace UserApi.Hall
return this.ToFailResult<BuyBattleOrderLevelResponse>(result.message);
}
/// <summary>
/// 购买战令进阶
/// </summary>
[HttpGet("BuyBattleOrderAdvance")]
public async Task<BaseResponse<BuyBattleOrderAdvanceResponse>> BuyBattleOrderAdvance(int type)
{
@@ -431,6 +518,9 @@ namespace UserApi.Hall
return this.ToFailResult<BuyBattleOrderAdvanceResponse>(result.message);
}
/// <summary>
/// 一键领取所有任务奖励
/// </summary>
[HttpGet("ReceiveAllTaskRewards")]
public async Task<BaseResponse<object>> ReceiveAllTaskRewards()
{
@@ -441,6 +531,9 @@ namespace UserApi.Hall
return this.ToFailResult<object>(result.message);
}
/// <summary>
/// 获取用户排行榜
/// </summary>
[HttpGet("GetRanking")]
public async Task<BaseResponse<RankingResponse>> GetRanking(int type = 1)
{
@@ -457,6 +550,9 @@ namespace UserApi.Hall
return this.ToResult(result);
}
/// <summary>
/// 使用大喇叭发送全服广播
/// </summary>
[HttpGet("SendBroadcast")]
public async Task<BaseResponse<string>> SendBroadcast(string message)
{
@@ -467,6 +563,9 @@ namespace UserApi.Hall
}
/// <summary>
/// 获取象棋分区总数
/// </summary>
[AllowAnonymous]
[HttpGet("GetChessRoomPartitionCount")]
public async Task<BaseResponse<int>> GetChessRoomPartitionCount([FromServices] UserService.GameConfigs.IGameConfigService gameConfigService)