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

@@ -31,7 +31,10 @@ public sealed class PermissionsController(IMediator mediator) : BaseApiControlle
[ProducesResponseType(typeof(ApiResponse<PagedResult<PermissionDto>>), StatusCodes.Status200OK)]
public async Task<ApiResponse<PagedResult<PermissionDto>>> Search([FromQuery] SearchPermissionsQuery query, CancellationToken cancellationToken)
{
// 1. 查询权限分页
var result = await mediator.Send(query, cancellationToken);
// 2. 返回分页数据
return ApiResponse<PagedResult<PermissionDto>>.Ok(result);
}
@@ -43,7 +46,10 @@ public sealed class PermissionsController(IMediator mediator) : BaseApiControlle
[ProducesResponseType(typeof(ApiResponse<PermissionDto>), StatusCodes.Status200OK)]
public async Task<ApiResponse<PermissionDto>> Create([FromBody, Required] CreatePermissionCommand command, CancellationToken cancellationToken)
{
// 1. 创建权限
var result = await mediator.Send(command, cancellationToken);
// 2. 返回创建结果
return ApiResponse<PermissionDto>.Ok(result);
}
@@ -56,8 +62,13 @@ public sealed class PermissionsController(IMediator mediator) : BaseApiControlle
[ProducesResponseType(typeof(ApiResponse<PermissionDto>), StatusCodes.Status404NotFound)]
public async Task<ApiResponse<PermissionDto>> Update(long permissionId, [FromBody, Required] UpdatePermissionCommand command, CancellationToken cancellationToken)
{
// 1. 绑定权限标识
command = command with { PermissionId = permissionId };
// 2. 执行更新
var result = await mediator.Send(command, cancellationToken);
// 3. 返回更新结果或 404
return result is null
? ApiResponse<PermissionDto>.Error(StatusCodes.Status404NotFound, "权限不存在")
: ApiResponse<PermissionDto>.Ok(result);
@@ -71,7 +82,10 @@ public sealed class PermissionsController(IMediator mediator) : BaseApiControlle
[ProducesResponseType(typeof(ApiResponse<bool>), StatusCodes.Status200OK)]
public async Task<ApiResponse<bool>> Delete(long permissionId, CancellationToken cancellationToken)
{
// 1. 构建删除命令
var command = new DeletePermissionCommand { PermissionId = permissionId };
// 2. 执行删除
var result = await mediator.Send(command, cancellationToken);
return ApiResponse<bool>.Ok(result);
}