docs: 完善AdminApi控制器注释和代码规范

This commit is contained in:
2025-12-04 14:23:04 +08:00
parent 37e7d721f3
commit 23b69f6f55
13 changed files with 70 additions and 0 deletions

View File

@@ -23,6 +23,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController
/// <summary>
/// 创建支付记录。
/// </summary>
/// <returns>创建的支付记录信息。</returns>
[HttpPost]
[PermissionAuthorize("payment:create")]
[ProducesResponseType(typeof(ApiResponse<PaymentDto>), StatusCodes.Status200OK)]
@@ -38,6 +39,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController
/// <summary>
/// 查询支付记录列表。
/// </summary>
/// <returns>支付记录分页列表。</returns>
[HttpGet]
[PermissionAuthorize("payment:read")]
[ProducesResponseType(typeof(ApiResponse<PagedResult<PaymentDto>>), StatusCodes.Status200OK)]
@@ -68,6 +70,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController
/// <summary>
/// 获取支付记录详情。
/// </summary>
/// <returns>支付记录详情。</returns>
[HttpGet("{paymentId:long}")]
[PermissionAuthorize("payment:read")]
[ProducesResponseType(typeof(ApiResponse<PaymentDto>), StatusCodes.Status200OK)]
@@ -86,6 +89,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController
/// <summary>
/// 更新支付记录。
/// </summary>
/// <returns>更新后的支付记录信息。</returns>
[HttpPut("{paymentId:long}")]
[PermissionAuthorize("payment:update")]
[ProducesResponseType(typeof(ApiResponse<PaymentDto>), StatusCodes.Status200OK)]
@@ -110,6 +114,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController
/// <summary>
/// 删除支付记录。
/// </summary>
/// <returns>删除结果。</returns>
[HttpDelete("{paymentId:long}")]
[PermissionAuthorize("payment:delete")]
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status200OK)]