938 lines
39 KiB
XML
938 lines
39 KiB
XML
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>HoneyBox.Api</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:HoneyBox.Api.Controllers.AuthController">
|
||
<summary>
|
||
认证控制器 - 处理用户登录、注册和手机号绑定
|
||
</summary>
|
||
<remarks>
|
||
提供微信小程序登录、手机号验证码登录、手机号绑定等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.WechatMiniProgramLogin(HoneyBox.Model.Models.Auth.WechatLoginRequest)">
|
||
<summary>
|
||
微信小程序登录
|
||
</summary>
|
||
<remarks>
|
||
POST /api/login
|
||
|
||
使用微信小程序授权code进行登录，返回JWT Token
|
||
Requirements: 1.1-1.8
|
||
</remarks>
|
||
<param name="request">微信登录请求参数，包含授权code</param>
|
||
<returns>登录成功返回JWT Token，失败返回错误信息</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.MobileLogin(HoneyBox.Model.Models.Auth.MobileLoginRequest)">
|
||
<summary>
|
||
手机号验证码登录
|
||
</summary>
|
||
<remarks>
|
||
POST /api/mobileLogin
|
||
|
||
使用手机号和验证码进行登录，返回JWT Token
|
||
Requirements: 2.1-2.7
|
||
</remarks>
|
||
<param name="request">手机号登录请求参数，包含手机号和验证码</param>
|
||
<returns>登录成功返回JWT Token，失败返回错误信息</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.LoginBindMobile(HoneyBox.Model.Models.Auth.BindMobileRequest)">
|
||
<summary>
|
||
微信授权绑定手机号
|
||
</summary>
|
||
<remarks>
|
||
POST /api/login_bind_mobile
|
||
|
||
使用微信授权code获取手机号并绑定到当前用户
|
||
Requirements: 5.1-5.5
|
||
</remarks>
|
||
<param name="request">绑定手机号请求参数，包含微信授权code</param>
|
||
<returns>绑定成功返回手机号信息，失败返回错误信息</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.BindMobile(HoneyBox.Model.Models.Auth.BindMobileWithCodeRequest)">
|
||
<summary>
|
||
验证码绑定手机号
|
||
</summary>
|
||
<remarks>
|
||
POST /api/bindMobile
|
||
|
||
使用手机号和验证码绑定手机号到当前用户
|
||
Requirements: 5.1-5.5
|
||
</remarks>
|
||
<param name="request">绑定手机号请求参数，包含手机号和验证码</param>
|
||
<returns>绑定成功返回手机号信息，失败返回错误信息</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.RecordLogin(HoneyBox.Model.Models.Auth.RecordLoginRequest)">
|
||
<summary>
|
||
记录用户登录
|
||
</summary>
|
||
<remarks>
|
||
GET|POST /api/login_record
|
||
|
||
记录用户登录信息，包括设备信息和IP地址
|
||
Requirements: 6.1-6.4
|
||
</remarks>
|
||
<param name="request">登录记录请求参数，包含设备信息（可选）</param>
|
||
<returns>登录记录结果</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.AuthController.GetClientIp">
|
||
<summary>
|
||
获取客户端IP地址
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.CollectionController">
|
||
<summary>
|
||
收藏控制器 - 处理商品收藏功能
|
||
</summary>
|
||
<remarks>
|
||
提供商品收藏、取消收藏、收藏列表查询等功能
|
||
Requirements: 6.1-6.4
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CollectionController.ToggleCollection(HoneyBox.Model.Models.Goods.CollectionRequest)">
|
||
<summary>
|
||
收藏/取消收藏商品
|
||
POST /api/addCollect
|
||
Requirements: 6.1-6.3
|
||
</summary>
|
||
<remarks>
|
||
切换收藏状态：如果已收藏则取消收藏，如果未收藏则添加收藏
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CollectionController.GetCollectionList(HoneyBox.Model.Models.Goods.CollectionListRequest)">
|
||
<summary>
|
||
获取收藏列表
|
||
POST /api/listCollect
|
||
Requirements: 6.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CollectionController.DeleteCollection(HoneyBox.Model.Models.Goods.DeleteCollectionRequest)">
|
||
<summary>
|
||
删除收藏
|
||
POST /api/delCollect
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CollectionController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.CouponController">
|
||
<summary>
|
||
优惠券控制器 - 处理优惠券相关功能
|
||
</summary>
|
||
<remarks>
|
||
提供优惠券列表查询、详情查询、领取、分享、合成等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.GetCouponList(HoneyBox.Model.Models.UserCoupon.UserCouponListRequest)">
|
||
<summary>
|
||
获取优惠券列表
|
||
</summary>
|
||
<remarks>
|
||
POST /api/coupon_list
|
||
|
||
获取当前用户的优惠券列表，支持按状态筛选
|
||
Requirements: 3.1-3.4
|
||
</remarks>
|
||
<param name="request">优惠券列表请求参数</param>
|
||
<returns>优惠券列表数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.GetCouponDetail(HoneyBox.Model.Models.UserCoupon.CouponDetailRequest)">
|
||
<summary>
|
||
获取优惠券详情
|
||
POST /api/coupon_detail
|
||
Requirements: 4.1-4.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.ShareCoupon(HoneyBox.Model.Models.UserCoupon.ShareCouponRequest)">
|
||
<summary>
|
||
分享优惠券
|
||
POST /api/coupon_share
|
||
Requirements: 5.1-5.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.ClaimCoupon(HoneyBox.Model.Models.UserCoupon.ClaimCouponRequest)">
|
||
<summary>
|
||
领取优惠券
|
||
</summary>
|
||
<remarks>
|
||
POST /api/coupon_ling
|
||
|
||
领取指定的优惠券
|
||
Requirements: 6.1-6.7
|
||
</remarks>
|
||
<param name="request">领取优惠券请求参数</param>
|
||
<returns>领取结果</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.CalculateSynthesis(HoneyBox.Model.Models.UserCoupon.SynthesisCalculateRequest)">
|
||
<summary>
|
||
计算优惠券合成
|
||
POST /api/coupon_ji_suan
|
||
Requirements: 7.1-7.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.SynthesisCoupons(HoneyBox.Model.Models.UserCoupon.SynthesisCouponsRequest)">
|
||
<summary>
|
||
执行优惠券合成
|
||
POST /api/coupon_synthesis
|
||
Requirements: 7.5
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.CouponController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.GoodsController">
|
||
<summary>
|
||
商品控制器 - 处理商品列表、详情、奖品等查询
|
||
</summary>
|
||
<remarks>
|
||
提供商品列表查询、商品详情、子奖品列表、箱号管理、中奖记录等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetGoodsList(HoneyBox.Model.Models.Goods.GoodsListRequest)">
|
||
<summary>
|
||
获取商品列表
|
||
</summary>
|
||
<remarks>
|
||
POST /api/goods_list
|
||
|
||
根据类型、分页参数获取商品列表
|
||
Requirements: 1.1-1.6
|
||
</remarks>
|
||
<param name="request">商品列表请求参数，包含类型、分页信息</param>
|
||
<returns>商品列表分页数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetGoodsDetail(HoneyBox.Model.Models.Goods.GoodsDetailRequest)">
|
||
<summary>
|
||
获取商品详情
|
||
</summary>
|
||
<remarks>
|
||
POST /api/goods_detail
|
||
|
||
根据商品ID获取商品详细信息，包含奖品列表、价格等
|
||
Requirements: 2.1-2.7
|
||
</remarks>
|
||
<param name="request">商品详情请求参数，包含商品ID和箱号</param>
|
||
<returns>商品详情数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetGoodsChildren(HoneyBox.Model.Models.Goods.GoodsChildrenRequest)">
|
||
<summary>
|
||
获取商品子奖品列表
|
||
POST /api/goods_children
|
||
Requirements: 3.1-3.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetGoodsExtend(HoneyBox.Model.Models.Goods.GoodsExtendRequest)">
|
||
<summary>
|
||
获取商品扩展配置
|
||
POST /api/goods_extend
|
||
Requirements: 4.1-4.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetBoxList(HoneyBox.Model.Models.Goods.BoxListRequest)">
|
||
<summary>
|
||
获取箱号列表
|
||
POST /api/goods_num_list
|
||
Requirements: 5.1
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetBoxDetail(HoneyBox.Model.Models.Goods.BoxDetailRequest)">
|
||
<summary>
|
||
获取箱号详情
|
||
POST /api/goods_num_detail
|
||
Requirements: 5.2-5.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetPrizeCount(HoneyBox.Model.Models.Goods.PrizeCountRequest)">
|
||
<summary>
|
||
获取奖品数量统计
|
||
POST /api/goods_prize_count
|
||
Requirements: 7.1
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetPrizeContent(HoneyBox.Model.Models.Goods.PrizeContentRequest)">
|
||
<summary>
|
||
获取奖品内容
|
||
POST /api/goods_prize_content
|
||
Requirements: 7.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetPrizeLogs(HoneyBox.Model.Models.Goods.PrizeLogsRequest)">
|
||
<summary>
|
||
获取中奖记录
|
||
</summary>
|
||
<remarks>
|
||
POST /api/goods_prize_logs
|
||
|
||
获取指定商品的中奖记录列表，支持分页
|
||
Requirements: 8.1-8.4
|
||
</remarks>
|
||
<param name="request">中奖记录请求参数，包含商品ID、箱号、分页信息</param>
|
||
<returns>中奖记录分页数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.GoodsController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.HealthController">
|
||
<summary>
|
||
健康检查控制器 - 提供系统健康状态检查
|
||
</summary>
|
||
<remarks>
|
||
检查数据库连接、Redis连接等系统组件的健康状态
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.HealthController.GetHealth">
|
||
<summary>
|
||
获取服务健康状态
|
||
</summary>
|
||
<returns>健康检查结果</returns>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.HealthCheckData">
|
||
<summary>
|
||
健康检查响应数据
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.HealthCheckData.Status">
|
||
<summary>
|
||
整体状态
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.HealthCheckData.Database">
|
||
<summary>
|
||
数据库连接状态
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.HealthCheckData.Redis">
|
||
<summary>
|
||
Redis 连接状态
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.HealthCheckData.Timestamp">
|
||
<summary>
|
||
检查时间戳
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.InvitationController">
|
||
<summary>
|
||
推荐/邀请控制器 - 处理用户邀请和推荐功能
|
||
</summary>
|
||
<remarks>
|
||
提供邀请信息查询、邀请码绑定等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.InvitationController.GetInvitationInfo(HoneyBox.Model.Models.Invitation.InvitationInfoRequest)">
|
||
<summary>
|
||
获取推荐信息
|
||
POST /api/invitation
|
||
Requirements: 9.1-9.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.InvitationController.BindInviteCode(HoneyBox.Model.Models.Invitation.BindInviteCodeRequest)">
|
||
<summary>
|
||
绑定邀请码
|
||
POST /api/bind_invite_code
|
||
Requirements: 9.3-9.5
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.InvitationController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.NotifyController">
|
||
<summary>
|
||
支付回调控制器
|
||
处理微信支付等第三方支付平台的回调通知
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.NotifyController.OrderNotify">
|
||
<summary>
|
||
微信支付回调接口
|
||
POST /api/notify/order_notify
|
||
接收微信支付结果通知，处理订单状态更新
|
||
Requirements: 2.1-2.9
|
||
</summary>
|
||
<remarks>
|
||
微信支付回调流程：
|
||
1. 接收微信发送的XML格式回调数据
|
||
2. 验证签名确保数据安全
|
||
3. 根据订单类型（attach字段）路由到对应处理方法
|
||
4. 更新订单状态、扣减用户资产、触发抽奖等
|
||
5. 返回XML格式响应给微信
|
||
|
||
支持的订单类型（attach值）：
|
||
- user_recharge: 余额充值
|
||
- order_yfs: 一番赏订单
|
||
- order_lts: 擂台赏订单
|
||
- order_zzs: 转转赏订单
|
||
- order_flw: 福利屋订单
|
||
- order_scs: 商城赏订单
|
||
- order_wxs: 无限赏订单
|
||
- order_fbs: 翻倍赏订单
|
||
- order_ckj: 抽卡机订单
|
||
- order_list_send: 发货运费
|
||
</remarks>
|
||
<returns>XML格式响应</returns>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.OrderController">
|
||
<summary>
|
||
订单控制器 - 处理订单创建、查询和抽奖结果
|
||
</summary>
|
||
<remarks>
|
||
提供一番赏、无限赏、商城等订单的创建、金额计算、查询和抽奖结果查询功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.CalculateOrderMoney(HoneyBox.Model.Models.Order.OrderMoneyRequest)">
|
||
<summary>
|
||
一番赏订单金额计算
|
||
</summary>
|
||
<remarks>
|
||
POST /api/ordermoney
|
||
|
||
计算一番赏订单金额，包含优惠券抵扣、余额抵扣等
|
||
Requirements: 1.1-1.6
|
||
</remarks>
|
||
<param name="request">订单金额计算请求参数</param>
|
||
<returns>订单金额计算结果</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.CreateOrder(HoneyBox.Model.Models.Order.OrderBuyRequest)">
|
||
<summary>
|
||
一番赏订单创建
|
||
</summary>
|
||
<remarks>
|
||
POST /api/orderbuy
|
||
|
||
创建一番赏订单并执行抽奖，返回订单信息和抽奖结果
|
||
Requirements: 2.1-2.6
|
||
</remarks>
|
||
<param name="request">订单创建请求参数</param>
|
||
<returns>订单创建结果，包含订单号和支付信息</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.CalculateInfiniteOrderMoney(HoneyBox.Model.Models.Order.InfiniteOrderMoneyRequest)">
|
||
<summary>
|
||
无限赏订单金额计算
|
||
POST /api/infinite_ordermoney
|
||
Requirements: 3.1-3.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.CreateInfiniteOrder(HoneyBox.Model.Models.Order.InfiniteOrderBuyRequest)">
|
||
<summary>
|
||
无限赏订单创建
|
||
POST /api/infinite_orderbuy
|
||
Requirements: 4.1-4.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.CalculateMallOrderMoney(HoneyBox.Model.Models.Order.MallOrderMoneyRequest)">
|
||
<summary>
|
||
商城订单金额计算
|
||
POST /api/mall_ordermoney
|
||
Requirements: 5.1-5.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetOrderList(HoneyBox.Model.Models.Order.OrderListRequest)">
|
||
<summary>
|
||
订单列表查询
|
||
</summary>
|
||
<remarks>
|
||
POST /api/order_list
|
||
|
||
获取当前用户的订单列表，支持按状态筛选和分页
|
||
Requirements: 6.1-6.4
|
||
</remarks>
|
||
<param name="request">订单列表请求参数</param>
|
||
<returns>订单列表分页数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetOrderDetail(HoneyBox.Model.Models.Order.OrderDetailRequest)">
|
||
<summary>
|
||
订单详情查询
|
||
POST /api/order_detail
|
||
Requirements: 7.1-7.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetPrizeOrderLog(HoneyBox.Model.Models.Order.PrizeOrderLogRequest)">
|
||
<summary>
|
||
一番赏抽奖结果查询
|
||
POST /api/prizeorderlog
|
||
Requirements: 8.1-8.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetInfinitePrizeOrderLog(HoneyBox.Model.Models.Order.PrizeOrderLogRequest)">
|
||
<summary>
|
||
无限赏抽奖结果查询
|
||
POST /api/infinite_prizeorderlog
|
||
Requirements: 9.1-9.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetInfiniteShangLog(HoneyBox.Model.Models.Lottery.InfiniteShangLogRequest)">
|
||
<summary>
|
||
无限赏中奖记录查询
|
||
POST /api/infinite_shang_log
|
||
Requirements: 4.1-4.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetInfinitePrizeRecords(HoneyBox.Model.Models.Lottery.InfinitePrizeRecordsRequest)">
|
||
<summary>
|
||
无限赏用户抽奖记录查询（盒子抽奖记录）
|
||
POST /api/infinite_prizerecords
|
||
Requirements: 5.1-5.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.DrawWithItemCard(HoneyBox.Model.Models.Lottery.ItemCardDrawRequest)">
|
||
<summary>
|
||
道具卡抽奖（重抽）
|
||
POST /api/item_card_chou
|
||
Requirements: 6.1-6.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.OrderController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.PayController">
|
||
<summary>
|
||
支付控制器
|
||
处理微信支付统一下单等支付相关接口
|
||
Requirements: 1.1-1.5
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.PayController.CreatePayment(HoneyBox.Api.Controllers.PayRequest)">
|
||
<summary>
|
||
微信支付统一下单接口
|
||
POST /api/pay
|
||
创建微信支付订单，返回支付参数供前端调起支付
|
||
Requirements: 1.1-1.5
|
||
</summary>
|
||
<remarks>
|
||
支付流程：
|
||
1. 验证用户登录状态
|
||
2. 验证请求参数
|
||
3. 调用微信支付统一下单API
|
||
4. 返回支付参数（appId, timeStamp, nonceStr, package, signType, paySign）
|
||
|
||
支持的订单类型（attach值）：
|
||
- user_recharge: 余额充值
|
||
- order_yfs: 一番赏订单
|
||
- order_lts: 擂台赏订单
|
||
- order_zzs: 转转赏订单
|
||
- order_flw: 福利屋订单
|
||
- order_scs: 商城赏订单
|
||
- order_wxs: 无限赏订单
|
||
- order_fbs: 翻倍赏订单
|
||
- order_ckj: 抽卡机订单
|
||
- order_list_send: 发货运费
|
||
</remarks>
|
||
<param name="request">支付请求参数</param>
|
||
<returns>支付参数或错误信息</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.PayController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.PayRequest">
|
||
<summary>
|
||
支付请求参数
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.PayRequest.OrderNo">
|
||
<summary>
|
||
订单号
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.PayRequest.Amount">
|
||
<summary>
|
||
支付金额（单位：元）
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.PayRequest.Body">
|
||
<summary>
|
||
商品描述
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.PayRequest.Attach">
|
||
<summary>
|
||
附加数据（订单类型）
|
||
</summary>
|
||
</member>
|
||
<member name="P:HoneyBox.Api.Controllers.PayRequest.OpenId">
|
||
<summary>
|
||
用户OpenId（可选，不传则从用户信息获取）
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.RankController">
|
||
<summary>
|
||
排行榜控制器 - 处理排行榜查询功能
|
||
</summary>
|
||
<remarks>
|
||
提供周榜、月榜等排行榜数据查询
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.RankController.GetWeekRank">
|
||
<summary>
|
||
获取周榜
|
||
</summary>
|
||
<remarks>
|
||
GET /api/rank_week
|
||
|
||
获取本周消费排行榜数据
|
||
Requirements: 10.1, 10.3-10.5
|
||
</remarks>
|
||
<returns>周榜数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.RankController.GetMonthRank">
|
||
<summary>
|
||
获取月榜
|
||
</summary>
|
||
<remarks>
|
||
GET /api/rank_month
|
||
|
||
获取本月消费排行榜数据
|
||
Requirements: 10.2-10.5
|
||
</remarks>
|
||
<returns>月榜数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.RankController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.RedeemController">
|
||
<summary>
|
||
兑换码控制器 - 处理兑换码使用功能
|
||
</summary>
|
||
<remarks>
|
||
提供兑换码验证和使用功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.RedeemController.UseRedeemCode(HoneyBox.Model.Models.Redeem.UseRedeemCodeRequest)">
|
||
<summary>
|
||
使用兑换码
|
||
POST /api/used
|
||
Requirements: 11.1-11.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.RedeemController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.TaskController">
|
||
<summary>
|
||
任务控制器 - 处理任务系统功能
|
||
</summary>
|
||
<remarks>
|
||
提供任务列表查询、任务奖励领取等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.TaskController.GetTaskList(HoneyBox.Model.Models.Task.TaskListRequest)">
|
||
<summary>
|
||
获取任务列表
|
||
POST /api/task_list
|
||
Requirements: 8.1-8.5
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.TaskController.ClaimTaskReward(HoneyBox.Model.Models.Task.ClaimTaskRewardRequest)">
|
||
<summary>
|
||
领取任务奖励
|
||
POST /api/ling_task
|
||
Requirements: 8.6-8.7
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.TaskController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.UserController">
|
||
<summary>
|
||
用户控制器 - 处理用户信息、资产和VIP相关功能
|
||
</summary>
|
||
<remarks>
|
||
提供用户信息查询和更新、资产明细查询、VIP信息查询等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetUserInfo">
|
||
<summary>
|
||
获取用户信息
|
||
</summary>
|
||
<remarks>
|
||
POST /api/user
|
||
|
||
获取当前登录用户的详细信息，包含余额、积分、VIP等级等
|
||
Requirements: 4.1-4.5
|
||
</remarks>
|
||
<returns>用户信息数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.UpdateUserInfo(HoneyBox.Model.Models.Auth.UpdateUserInfoRequest)">
|
||
<summary>
|
||
更新用户信息
|
||
POST /api/update_userinfo
|
||
Requirements: 4.2, 4.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.LogOff(HoneyBox.Model.Models.Auth.LogOffRequest)">
|
||
<summary>
|
||
账号注销
|
||
POST /api/user_log_off
|
||
Requirements: 7.1-7.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetMoneyRecords(HoneyBox.Model.Models.Asset.AssetRecordRequest)">
|
||
<summary>
|
||
获取余额明细
|
||
POST /api/profitMoney
|
||
Requirements: 1.1
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetIntegralRecords(HoneyBox.Model.Models.Asset.AssetRecordRequest)">
|
||
<summary>
|
||
获取吧唧币明细
|
||
POST /api/profitIntegral
|
||
Requirements: 1.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetScoreRecords(HoneyBox.Model.Models.Asset.AssetRecordRequest)">
|
||
<summary>
|
||
获取积分明细
|
||
POST /api/profitScore
|
||
Requirements: 1.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetPayRecords(HoneyBox.Model.Models.Asset.AssetRecordRequest)">
|
||
<summary>
|
||
获取支付记录
|
||
POST /api/profitPay
|
||
Requirements: 1.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetVipInfo">
|
||
<summary>
|
||
获取VIP信息
|
||
</summary>
|
||
<remarks>
|
||
POST /api/vip_list
|
||
|
||
获取当前用户的VIP等级信息和权益列表
|
||
Requirements: 2.1-2.5
|
||
</remarks>
|
||
<returns>VIP信息数据</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.UserController.UploadBase64ImageAsync(System.String,System.Int32)">
|
||
<summary>
|
||
上传Base64图片到腾讯云COS
|
||
</summary>
|
||
<param name="base64Image">Base64编码的图片数据</param>
|
||
<param name="userId">用户ID</param>
|
||
<returns>上传后的图片URL</returns>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.WarehouseController">
|
||
<summary>
|
||
仓库控制器 - 处理用户仓库和发货功能
|
||
</summary>
|
||
<remarks>
|
||
提供仓库查询、奖品回收、发货申请、物流查询等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.GetWarehouseIndex(HoneyBox.Model.Models.Order.WarehouseIndexRequest)">
|
||
<summary>
|
||
仓库首页查询
|
||
</summary>
|
||
<remarks>
|
||
POST /api/warehouse_index
|
||
|
||
获取用户仓库中的奖品列表
|
||
Requirements: 10.1-10.3
|
||
</remarks>
|
||
<param name="request">仓库查询请求参数</param>
|
||
<returns>仓库奖品列表</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.RecoveryPrizes(HoneyBox.Model.Models.Order.RecoveryRequest)">
|
||
<summary>
|
||
奖品回收
|
||
POST /api/warehouse_recovery
|
||
Requirements: 11.1-11.5
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.SendPrizes(HoneyBox.Model.Models.Order.SendRequest)">
|
||
<summary>
|
||
奖品发货申请
|
||
</summary>
|
||
<remarks>
|
||
POST /api/warehouse_send
|
||
|
||
申请将仓库中的奖品发货到指定地址
|
||
Requirements: 12.1-12.5
|
||
</remarks>
|
||
<param name="request">发货申请请求参数</param>
|
||
<returns>发货申请结果</returns>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.ConfirmSend(HoneyBox.Model.Models.Order.ConfirmSendRequest)">
|
||
<summary>
|
||
确认发货
|
||
POST /api/warehouse_send_confirm
|
||
Requirements: 13.1-13.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.GetSendRecords(HoneyBox.Model.Models.Order.SendRecordRequest)">
|
||
<summary>
|
||
发货记录查询
|
||
POST /api/warehouse_send_record
|
||
Requirements: 14.1-14.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.GetSendRecordDetail(HoneyBox.Model.Models.Order.SendRecordDetailRequest)">
|
||
<summary>
|
||
发货记录详情查询
|
||
POST /api/warehouse_send_record_detail
|
||
Requirements: 15.1-15.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.GetRecoveryRecords(HoneyBox.Model.Models.Order.RecoveryRecordRequest)">
|
||
<summary>
|
||
回收记录查询
|
||
POST /api/warehouse_recovery_record
|
||
Requirements: 16.1-16.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.GetLogistics(HoneyBox.Model.Models.Order.LogisticsRequest)">
|
||
<summary>
|
||
物流信息查询
|
||
POST /api/warehouse_order_logistics
|
||
Requirements: 17.1-17.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WarehouseController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Controllers.WelfareController">
|
||
<summary>
|
||
福利屋控制器 - 处理福利屋抽奖功能
|
||
</summary>
|
||
<remarks>
|
||
提供福利屋列表、详情、参与记录、中奖记录等功能
|
||
</remarks>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetWelfareList(HoneyBox.Model.Models.Welfare.WelfareListRequest)">
|
||
<summary>
|
||
获取福利屋列表
|
||
POST /api/welfare_house_list
|
||
Requirements: 12.1-12.5
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetWelfareDetail(HoneyBox.Model.Models.Welfare.WelfareDetailRequest)">
|
||
<summary>
|
||
获取福利屋详情
|
||
POST /api/fuliwu_detail
|
||
Requirements: 13.1-13.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetParticipants(HoneyBox.Model.Models.Welfare.ParticipantsRequest)">
|
||
<summary>
|
||
获取福利屋参与者列表
|
||
POST /api/fuliwu_participants
|
||
Requirements: 14.1
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetWinningRecords(HoneyBox.Model.Models.Welfare.WinningRecordsRequest)">
|
||
<summary>
|
||
获取福利屋开奖记录
|
||
POST /api/fuliwu_records
|
||
Requirements: 14.2
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetUserParticipationRecords(System.Int32,System.Int32)">
|
||
<summary>
|
||
获取用户参与记录
|
||
GET /api/fuliwu_user_records
|
||
Requirements: 14.3
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetUserWinningRecords(System.Int32,System.Int32)">
|
||
<summary>
|
||
获取用户中奖记录
|
||
GET /api/fuliwu_user_winning_records
|
||
Requirements: 14.4
|
||
</summary>
|
||
</member>
|
||
<member name="M:HoneyBox.Api.Controllers.WelfareController.GetCurrentUserId">
|
||
<summary>
|
||
获取当前登录用户ID
|
||
</summary>
|
||
</member>
|
||
<member name="T:HoneyBox.Api.Filters.GlobalExceptionFilter">
|
||
<summary>
|
||
全局异常处理过滤器
|
||
</summary>
|
||
</member>
|
||
<member name="T:Program">
|
||
<summary>
|
||
Auto-generated public partial Program class for top-level statement apps.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Microsoft.AspNetCore.OpenApi.Generated.DocumentationCommentIdHelper.CreateDocumentationId(System.Type)">
|
||
<summary>
|
||
Generates a documentation comment ID for a type.
|
||
Example: T:Namespace.Outer+Inner`1 becomes T:Namespace.Outer.Inner`1
|
||
</summary>
|
||
</member>
|
||
<member name="M:Microsoft.AspNetCore.OpenApi.Generated.DocumentationCommentIdHelper.CreateDocumentationId(System.Reflection.PropertyInfo)">
|
||
<summary>
|
||
Generates a documentation comment ID for a property.
|
||
Example: P:Namespace.ContainingType.PropertyName or for an indexer P:Namespace.ContainingType.Item(System.Int32)
|
||
</summary>
|
||
</member>
|
||
<member name="M:Microsoft.AspNetCore.OpenApi.Generated.DocumentationCommentIdHelper.CreateDocumentationId(System.Type,System.String)">
|
||
<summary>
|
||
Generates a documentation comment ID for a property given its container type and property name.
|
||
Example: P:Namespace.ContainingType.PropertyName
|
||
</summary>
|
||
</member>
|
||
<member name="M:Microsoft.AspNetCore.OpenApi.Generated.DocumentationCommentIdHelper.CreateDocumentationId(System.Reflection.MethodInfo)">
|
||
<summary>
|
||
Generates a documentation comment ID for a method (or constructor).
|
||
For example:
|
||
M:Namespace.ContainingType.MethodName(ParamType1,ParamType2)~ReturnType
|
||
M:Namespace.ContainingType.#ctor(ParamType)
|
||
</summary>
|
||
</member>
|
||
<member name="M:Microsoft.AspNetCore.OpenApi.Generated.DocumentationCommentIdHelper.GetTypeDocId(System.Type,System.Boolean,System.Boolean)">
|
||
<summary>
|
||
Generates a documentation ID string for a type.
|
||
This method handles nested types (replacing '+' with '.'),
|
||
generic types, arrays, pointers, by-ref types, and generic parameters.
|
||
The <paramref name="includeGenericArguments"/> flag controls whether
|
||
constructed generic type arguments are emitted, while <paramref name="omitGenericArity"/>
|
||
controls whether the generic arity marker (e.g. "`1") is appended.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Microsoft.AspNetCore.OpenApi.Generated.DocumentationCommentIdHelper.NormalizeDocId(System.String)">
|
||
<summary>
|
||
Normalizes a documentation comment ID to match the compiler-style format.
|
||
Strips the return type suffix for ordinary methods but retains it for conversion operators.
|
||
</summary>
|
||
<param name="docId">The documentation comment ID to normalize.</param>
|
||
<returns>The normalized documentation comment ID.</returns>
|
||
</member>
|
||
</members>
|
||
</doc>
|