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,8 +1,4 @@
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using TakeoutSaaS.Application.Identity.Abstractions;
using TakeoutSaaS.Application.Identity.Contracts;
@@ -26,6 +22,9 @@ public sealed class AuthController(IAdminAuthService authService) : BaseApiContr
/// <summary>
/// 登录获取 Token
/// </summary>
/// <param name="request">登录请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>包含访问令牌与刷新令牌的响应。</returns>
[HttpPost("login")]
[AllowAnonymous]
[ProducesResponseType(typeof(ApiResponse<TokenResponse>), StatusCodes.Status200OK)]
@@ -38,6 +37,9 @@ public sealed class AuthController(IAdminAuthService authService) : BaseApiContr
/// <summary>
/// 刷新 Token
/// </summary>
/// <param name="request">刷新令牌请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>新的访问令牌与刷新令牌。</returns>
[HttpPost("refresh")]
[AllowAnonymous]
[ProducesResponseType(typeof(ApiResponse<TokenResponse>), StatusCodes.Status200OK)]
@@ -73,6 +75,8 @@ public sealed class AuthController(IAdminAuthService authService) : BaseApiContr
/// }
/// </code>
/// </remarks>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>当前用户档案信息。</returns>
[HttpGet("profile")]
[PermissionAuthorize("identity:profile:read")]
[ProducesResponseType(typeof(ApiResponse<CurrentUserProfile>), StatusCodes.Status200OK)]
@@ -116,6 +120,9 @@ public sealed class AuthController(IAdminAuthService authService) : BaseApiContr
/// }
/// </code>
/// </remarks>
/// <param name="userId">目标用户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>用户权限概览,未找到则返回 404。</returns>
[HttpGet("permissions/{userId:long}")]
[PermissionAuthorize("identity:permission:read")]
[ProducesResponseType(typeof(ApiResponse<UserPermissionDto>), StatusCodes.Status200OK)]