chore: add documentation comments and stylecop rules

This commit is contained in:
2025-12-04 11:25:01 +08:00
parent 17d143a351
commit 8e4c2b0e45
142 changed files with 1309 additions and 439 deletions

View File

@@ -10,17 +10,13 @@ namespace TakeoutSaaS.MiniApi.Controllers;
/// <summary>
/// 小程序登录认证
/// </summary>
/// <remarks>
/// 小程序登录认证
/// </remarks>
/// <param name="authService"></param>
/// <remarks>提供小程序端的微信登录与 Token 刷新能力。</remarks>
/// <param name="authService">小程序认证服务</param>
[ApiVersion("1.0")]
[Authorize]
[Route("api/mini/v{version:apiVersion}/auth")]
public sealed class AuthController(IMiniAuthService authService) : BaseApiController
{
/// <summary>
/// 微信登录
/// </summary>
@@ -29,7 +25,10 @@ public sealed class AuthController(IMiniAuthService authService) : BaseApiContro
[ProducesResponseType(typeof(ApiResponse<TokenResponse>), StatusCodes.Status200OK)]
public async Task<ApiResponse<TokenResponse>> LoginWithWeChat([FromBody] WeChatLoginRequest request, CancellationToken cancellationToken)
{
// 1. 调用认证服务完成微信登录
var response = await authService.LoginWithWeChatAsync(request, cancellationToken);
// 2. 返回访问与刷新令牌
return ApiResponse<TokenResponse>.Ok(response);
}
@@ -41,7 +40,10 @@ public sealed class AuthController(IMiniAuthService authService) : BaseApiContro
[ProducesResponseType(typeof(ApiResponse<TokenResponse>), StatusCodes.Status200OK)]
public async Task<ApiResponse<TokenResponse>> RefreshToken([FromBody] RefreshTokenRequest request, CancellationToken cancellationToken)
{
// 1. 调用认证服务刷新 Token
var response = await authService.RefreshTokenAsync(request, cancellationToken);
// 2. 返回新的令牌
return ApiResponse<TokenResponse>.Ok(response);
}
}