docs: 完善参数注释与StyleCop配置

This commit is contained in:
2025-12-04 12:45:26 +08:00
parent 8e4c2b0e45
commit 37e7d721f3
213 changed files with 695 additions and 446 deletions

View File

@@ -1,6 +1,5 @@
using MediatR;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using TakeoutSaaS.Application.App.Merchants.Commands;
using TakeoutSaaS.Application.App.Merchants.Dto;
@@ -24,6 +23,9 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 创建商户。
/// </summary>
/// <param name="command">创建命令。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>创建后的商户。</returns>
[HttpPost]
[PermissionAuthorize("merchant:create")]
[ProducesResponseType(typeof(ApiResponse<MerchantDto>), StatusCodes.Status200OK)]
@@ -39,6 +41,13 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 查询商户列表。
/// </summary>
/// <param name="status">状态筛选。</param>
/// <param name="page">页码。</param>
/// <param name="pageSize">每页大小。</param>
/// <param name="sortBy">排序字段。</param>
/// <param name="sortDesc">是否倒序。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>商户分页结果。</returns>
[HttpGet]
[PermissionAuthorize("merchant:read")]
[ProducesResponseType(typeof(ApiResponse<IReadOnlyList<MerchantDto>>), StatusCodes.Status200OK)]
@@ -67,6 +76,10 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 更新商户。
/// </summary>
/// <param name="merchantId">商户 ID。</param>
/// <param name="command">更新命令。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>更新后的商户或未找到。</returns>
[HttpPut("{merchantId:long}")]
[PermissionAuthorize("merchant:update")]
[ProducesResponseType(typeof(ApiResponse<MerchantDto>), StatusCodes.Status200OK)]
@@ -91,6 +104,9 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 删除商户。
/// </summary>
/// <param name="merchantId">商户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>删除结果。</returns>
[HttpDelete("{merchantId:long}")]
[PermissionAuthorize("merchant:delete")]
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status200OK)]
@@ -109,6 +125,9 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 获取商户概览。
/// </summary>
/// <param name="merchantId">商户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>商户概览或未找到。</returns>
[HttpGet("{merchantId:long}")]
[PermissionAuthorize("merchant:read")]
[ProducesResponseType(typeof(ApiResponse<MerchantDto>), StatusCodes.Status200OK)]