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

@@ -25,6 +25,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
/// <summary>
/// 创建系统参数。
/// </summary>
/// <returns>创建的系统参数信息。</returns>
[HttpPost]
[PermissionAuthorize("system-parameter:create")]
[ProducesResponseType(typeof(ApiResponse<SystemParameterDto>), StatusCodes.Status200OK)]
@@ -40,6 +41,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
/// <summary>
/// 查询系统参数列表。
/// </summary>
/// <returns>分页的系统参数列表。</returns>
[HttpGet]
[PermissionAuthorize("system-parameter:read")]
[ProducesResponseType(typeof(ApiResponse<PagedResult<SystemParameterDto>>), StatusCodes.Status200OK)]
@@ -70,6 +72,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
/// <summary>
/// 获取系统参数详情。
/// </summary>
/// <returns>系统参数详情。</returns>
[HttpGet("{parameterId:long}")]
[PermissionAuthorize("system-parameter:read")]
[ProducesResponseType(typeof(ApiResponse<SystemParameterDto>), StatusCodes.Status200OK)]
@@ -88,6 +91,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
/// <summary>
/// 更新系统参数。
/// </summary>
/// <returns>更新后的系统参数信息。</returns>
[HttpPut("{parameterId:long}")]
[PermissionAuthorize("system-parameter:update")]
[ProducesResponseType(typeof(ApiResponse<SystemParameterDto>), StatusCodes.Status200OK)]
@@ -112,6 +116,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
/// <summary>
/// 删除系统参数。
/// </summary>
/// <returns>删除结果。</returns>
[HttpDelete("{parameterId:long}")]
[PermissionAuthorize("system-parameter:delete")]
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status200OK)]