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

@@ -22,6 +22,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 注册租户并初始化套餐。
/// </summary>
/// <returns>注册的租户信息。</returns>
[HttpPost]
[PermissionAuthorize("tenant:create")]
[ProducesResponseType(typeof(ApiResponse<TenantDto>), StatusCodes.Status200OK)]
@@ -37,6 +38,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 分页查询租户。
/// </summary>
/// <returns>租户分页结果。</returns>
[HttpGet]
[PermissionAuthorize("tenant:read")]
[ProducesResponseType(typeof(ApiResponse<PagedResult<TenantDto>>), StatusCodes.Status200OK)]
@@ -52,6 +54,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 查看租户详情。
/// </summary>
/// <returns>租户详情。</returns>
[HttpGet("{tenantId:long}")]
[PermissionAuthorize("tenant:read")]
[ProducesResponseType(typeof(ApiResponse<TenantDetailDto>), StatusCodes.Status200OK)]
@@ -67,6 +70,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 提交或更新实名认证资料。
/// </summary>
/// <returns>提交的实名认证信息。</returns>
[HttpPost("{tenantId:long}/verification")]
[PermissionAuthorize("tenant:review")]
[ProducesResponseType(typeof(ApiResponse<TenantVerificationDto>), StatusCodes.Status200OK)]
@@ -88,6 +92,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 审核租户。
/// </summary>
/// <returns>审核后的租户信息。</returns>
[HttpPost("{tenantId:long}/review")]
[PermissionAuthorize("tenant:review")]
[ProducesResponseType(typeof(ApiResponse<TenantDto>), StatusCodes.Status200OK)]
@@ -106,6 +111,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 创建或续费租户订阅。
/// </summary>
/// <returns>创建或续费的订阅信息。</returns>
[HttpPost("{tenantId:long}/subscriptions")]
[PermissionAuthorize("tenant:subscription")]
[ProducesResponseType(typeof(ApiResponse<TenantSubscriptionDto>), StatusCodes.Status200OK)]
@@ -125,6 +131,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 套餐升降配。
/// </summary>
/// <returns>更新后的订阅信息。</returns>
[HttpPut("{tenantId:long}/subscriptions/{subscriptionId:long}/plan")]
[PermissionAuthorize("tenant:subscription")]
[ProducesResponseType(typeof(ApiResponse<TenantSubscriptionDto>), StatusCodes.Status200OK)]
@@ -147,6 +154,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// <summary>
/// 查询审核日志。
/// </summary>
/// <returns>租户审核日志分页结果。</returns>
[HttpGet("{tenantId:long}/audits")]
[PermissionAuthorize("tenant:read")]
[ProducesResponseType(typeof(ApiResponse<PagedResult<TenantAuditLogDto>>), StatusCodes.Status200OK)]
@@ -168,6 +176,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController
/// 配额校验并占用额度(门店/账号/短信/配送)。
/// </summary>
/// <remarks>需在请求头携带 X-Tenant-Id 对应的租户。</remarks>
/// <returns>配额校验结果。</returns>
[HttpPost("{tenantId:long}/quotas/check")]
[PermissionAuthorize("tenant:quota:check")]
[ProducesResponseType(typeof(ApiResponse<QuotaCheckResultDto>), StatusCodes.Status200OK)]