From 23b69f6f556eeb16c3456c7d006e0b74f45ae562 Mon Sep 17 00:00:00 2001 From: MSuMshk <2039814060@qq.com> Date: Thu, 4 Dec 2025 14:23:04 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84AdminApi=E6=8E=A7?= =?UTF-8?q?=E5=88=B6=E5=99=A8=E6=B3=A8=E9=87=8A=E5=92=8C=E4=BB=A3=E7=A0=81?= =?UTF-8?q?=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + .../Controllers/FilesController.cs | 1 + .../Controllers/MerchantsController.cs | 10 ++++++++++ .../Controllers/OrdersController.cs | 5 +++++ .../Controllers/PaymentsController.cs | 5 +++++ .../Controllers/ProductsController.cs | 5 +++++ .../Controllers/RolesController.cs | 12 ++++++++++++ .../Controllers/StoresController.cs | 5 +++++ .../Controllers/SystemParametersController.cs | 5 +++++ .../Controllers/TenantAnnouncementsController.cs | 6 ++++++ .../Controllers/TenantBillingsController.cs | 4 ++++ .../Controllers/TenantNotificationsController.cs | 2 ++ .../Controllers/TenantsController.cs | 9 +++++++++ 13 files changed, 70 insertions(+) diff --git a/.gitignore b/.gitignore index 3857e65..16baddd 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ bin/ obj/ **/bin/ **/obj/ +.claude/ diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/FilesController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/FilesController.cs index a6d77a4..cd92566 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/FilesController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/FilesController.cs @@ -20,6 +20,7 @@ public sealed class FilesController(IFileStorageService fileStorageService) : Ba /// /// 上传图片或文件。 /// + /// 文件上传响应信息。 [HttpPost("upload")] [RequestFormLimits(MultipartBodyLengthLimit = 30 * 1024 * 1024)] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/MerchantsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/MerchantsController.cs index b886c5c..c5b52d0 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/MerchantsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/MerchantsController.cs @@ -146,6 +146,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 获取商户详细资料（含证照、合同）。 /// + /// 创建的证照信息。 [HttpGet("{merchantId:long}/detail")] [PermissionAuthorize("merchant:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -161,6 +162,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 上传商户证照信息（先通过文件上传接口获取 COS 地址）。 /// + /// 创建的证照信息。 [HttpPost("{merchantId:long}/documents")] [PermissionAuthorize("merchant:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -180,6 +182,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 商户证照列表。 /// + /// 商户证照列表。 [HttpGet("{merchantId:long}/documents")] [PermissionAuthorize("merchant:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -195,6 +198,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 审核指定证照。 /// + /// 审核后的证照信息。 [HttpPost("{merchantId:long}/documents/{documentId:long}/review")] [PermissionAuthorize("merchant:review")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -215,6 +219,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 新增商户合同。 /// + /// 创建的合同信息。 [HttpPost("{merchantId:long}/contracts")] [PermissionAuthorize("merchant:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -234,6 +239,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 合同列表。 /// + /// 商户合同列表。 [HttpGet("{merchantId:long}/contracts")] [PermissionAuthorize("merchant:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -249,6 +255,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 更新合同状态（生效/终止等）。 /// + /// 更新后的合同信息。 [HttpPut("{merchantId:long}/contracts/{contractId:long}/status")] [PermissionAuthorize("merchant:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -269,6 +276,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 审核商户（通过/驳回）。 /// + /// 审核后的商户信息。 [HttpPost("{merchantId:long}/review")] [PermissionAuthorize("merchant:review")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -285,6 +293,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 审核日志。 /// + /// 商户审核日志分页结果。 [HttpGet("{merchantId:long}/audits")] [PermissionAuthorize("merchant:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -304,6 +313,7 @@ public sealed class MerchantsController(IMediator mediator) : BaseApiController /// /// 可选商户类目列表。 /// + /// 可选的商户类目列表。 [HttpGet("categories")] [PermissionAuthorize("merchant:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/OrdersController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/OrdersController.cs index 9a0db09..d190e96 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/OrdersController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/OrdersController.cs @@ -24,6 +24,7 @@ public sealed class OrdersController(IMediator mediator) : BaseApiController /// /// 创建订单。 /// + /// 创建的订单信息。 [HttpPost] [PermissionAuthorize("order:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -39,6 +40,7 @@ public sealed class OrdersController(IMediator mediator) : BaseApiController /// /// 查询订单列表。 /// + /// 订单分页列表。 [HttpGet] [PermissionAuthorize("order:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -73,6 +75,7 @@ public sealed class OrdersController(IMediator mediator) : BaseApiController /// /// 获取订单详情。 /// + /// 订单详情。 [HttpGet("{orderId:long}")] [PermissionAuthorize("order:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -91,6 +94,7 @@ public sealed class OrdersController(IMediator mediator) : BaseApiController /// /// 更新订单。 /// + /// 更新后的订单信息。 [HttpPut("{orderId:long}")] [PermissionAuthorize("order:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -115,6 +119,7 @@ public sealed class OrdersController(IMediator mediator) : BaseApiController /// /// 删除订单。 /// + /// 删除结果。 [HttpDelete("{orderId:long}")] [PermissionAuthorize("order:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/PaymentsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/PaymentsController.cs index ecf4fee..287f893 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/PaymentsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/PaymentsController.cs @@ -23,6 +23,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController /// /// 创建支付记录。 /// + /// 创建的支付记录信息。 [HttpPost] [PermissionAuthorize("payment:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -38,6 +39,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController /// /// 查询支付记录列表。 /// + /// 支付记录分页列表。 [HttpGet] [PermissionAuthorize("payment:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -68,6 +70,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController /// /// 获取支付记录详情。 /// + /// 支付记录详情。 [HttpGet("{paymentId:long}")] [PermissionAuthorize("payment:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -86,6 +89,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController /// /// 更新支付记录。 /// + /// 更新后的支付记录信息。 [HttpPut("{paymentId:long}")] [PermissionAuthorize("payment:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -110,6 +114,7 @@ public sealed class PaymentsController(IMediator mediator) : BaseApiController /// /// 删除支付记录。 /// + /// 删除结果。 [HttpDelete("{paymentId:long}")] [PermissionAuthorize("payment:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/ProductsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/ProductsController.cs index 1bc75f0..30653f4 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/ProductsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/ProductsController.cs @@ -23,6 +23,7 @@ public sealed class ProductsController(IMediator mediator) : BaseApiController /// /// 创建商品。 /// + /// 创建的商品信息。 [HttpPost] [PermissionAuthorize("product:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -38,6 +39,7 @@ public sealed class ProductsController(IMediator mediator) : BaseApiController /// /// 查询商品列表。 /// + /// 商品分页列表。 [HttpGet] [PermissionAuthorize("product:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -70,6 +72,7 @@ public sealed class ProductsController(IMediator mediator) : BaseApiController /// /// 获取商品详情。 /// + /// 商品详情。 [HttpGet("{productId:long}")] [PermissionAuthorize("product:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -88,6 +91,7 @@ public sealed class ProductsController(IMediator mediator) : BaseApiController /// /// 更新商品。 /// + /// 更新后的商品信息。 [HttpPut("{productId:long}")] [PermissionAuthorize("product:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -112,6 +116,7 @@ public sealed class ProductsController(IMediator mediator) : BaseApiController /// /// 删除商品。 /// + /// 删除结果。 [HttpDelete("{productId:long}")] [PermissionAuthorize("product:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/RolesController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/RolesController.cs index d22f627..7c97263 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/RolesController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/RolesController.cs @@ -25,6 +25,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 示例：GET /api/admin/v1/roles/templates /// + /// 角色模板列表。 [HttpGet("templates")] [PermissionAuthorize("identity:role:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -43,6 +44,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 示例：GET /api/admin/v1/roles/templates/tenant-admin /// + /// 角色模板详情。 [HttpGet("templates/{templateCode}")] [PermissionAuthorize("identity:role:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -61,6 +63,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 创建角色模板。 /// + /// 创建的角色模板信息。 [HttpPost("templates")] [PermissionAuthorize("role-template:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -76,6 +79,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 更新角色模板。 /// + /// 更新后的角色模板信息。 [HttpPut("templates/{templateCode}")] [PermissionAuthorize("role-template:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -100,6 +104,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 删除角色模板。 /// + /// 删除结果。 [HttpDelete("templates/{templateCode}")] [PermissionAuthorize("role-template:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -119,6 +124,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// 示例：POST /api/admin/v1/roles/templates/store-manager/copy /// Body: { "roleName": "新区店长" } /// + /// 创建的角色信息。 [HttpPost("templates/{templateCode}/copy")] [PermissionAuthorize("identity:role:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -142,6 +148,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// 示例：POST /api/admin/v1/roles/templates/init /// Body: { "templateCodes": ["tenant-admin","store-manager","store-staff"] } /// + /// 创建的角色列表。 [HttpPost("templates/init")] [PermissionAuthorize("identity:role:create")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -165,6 +172,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// GET /api/admin/v1/roles?keyword=ops&page=1&pageSize=20 /// Header: Authorization: Bearer <JWT> + X-Tenant-Id /// + /// 角色分页结果。 [HttpGet] [PermissionAuthorize("identity:role:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -180,6 +188,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 创建角色。 /// + /// 创建的角色信息。 [HttpPost] [PermissionAuthorize("identity:role:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -195,6 +204,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 更新角色。 /// + /// 更新后的角色信息。 [HttpPut("{roleId:long}")] [PermissionAuthorize("identity:role:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -216,6 +226,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 删除角色。 /// + /// 删除结果。 [HttpDelete("{roleId:long}")] [PermissionAuthorize("identity:role:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -232,6 +243,7 @@ public sealed class RolesController(IMediator mediator) : BaseApiController /// /// 绑定角色权限（覆盖式）。 /// + /// 是否绑定成功。 [HttpPut("{roleId:long}/permissions")] [PermissionAuthorize("identity:role:bind-permission")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/StoresController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/StoresController.cs index ffcde02..f5479fa 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/StoresController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/StoresController.cs @@ -23,6 +23,7 @@ public sealed class StoresController(IMediator mediator) : BaseApiController /// /// 创建门店。 /// + /// 创建的门店信息。 [HttpPost] [PermissionAuthorize("store:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -38,6 +39,7 @@ public sealed class StoresController(IMediator mediator) : BaseApiController /// /// 查询门店列表。 /// + /// 门店分页列表。 [HttpGet] [PermissionAuthorize("store:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -68,6 +70,7 @@ public sealed class StoresController(IMediator mediator) : BaseApiController /// /// 获取门店详情。 /// + /// 门店详情。 [HttpGet("{storeId:long}")] [PermissionAuthorize("store:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -86,6 +89,7 @@ public sealed class StoresController(IMediator mediator) : BaseApiController /// /// 更新门店。 /// + /// 更新后的门店信息。 [HttpPut("{storeId:long}")] [PermissionAuthorize("store:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -110,6 +114,7 @@ public sealed class StoresController(IMediator mediator) : BaseApiController /// /// 删除门店。 /// + /// 删除结果。 [HttpDelete("{storeId:long}")] [PermissionAuthorize("store:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/SystemParametersController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/SystemParametersController.cs index 7a45183..7a2fcb2 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/SystemParametersController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/SystemParametersController.cs @@ -25,6 +25,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont /// /// 创建系统参数。 /// + /// 创建的系统参数信息。 [HttpPost] [PermissionAuthorize("system-parameter:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -40,6 +41,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont /// /// 查询系统参数列表。 /// + /// 分页的系统参数列表。 [HttpGet] [PermissionAuthorize("system-parameter:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -70,6 +72,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont /// /// 获取系统参数详情。 /// + /// 系统参数详情。 [HttpGet("{parameterId:long}")] [PermissionAuthorize("system-parameter:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -88,6 +91,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont /// /// 更新系统参数。 /// + /// 更新后的系统参数信息。 [HttpPut("{parameterId:long}")] [PermissionAuthorize("system-parameter:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -112,6 +116,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont /// /// 删除系统参数。 /// + /// 删除结果。 [HttpDelete("{parameterId:long}")] [PermissionAuthorize("system-parameter:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantAnnouncementsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantAnnouncementsController.cs index 1ba6147..b99b30f 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantAnnouncementsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantAnnouncementsController.cs @@ -22,6 +22,7 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC /// /// 分页查询公告。 /// + /// 租户公告分页结果。 [HttpGet] [PermissionAuthorize("tenant-announcement:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -40,6 +41,7 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC /// /// 公告详情。 /// + /// 租户公告详情。 [HttpGet("{announcementId:long}")] [PermissionAuthorize("tenant-announcement:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -58,6 +60,7 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC /// /// 创建公告。 /// + /// 创建的公告信息。 [HttpPost] [PermissionAuthorize("tenant-announcement:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -74,6 +77,7 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC /// /// 更新公告。 /// + /// 更新后的公告信息。 [HttpPut("{announcementId:long}")] [PermissionAuthorize("tenant-announcement:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -95,6 +99,7 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC /// /// 删除公告。 /// + /// 删除结果。 [HttpDelete("{announcementId:long}")] [PermissionAuthorize("tenant-announcement:delete")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -110,6 +115,7 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC /// /// 标记公告已读。 /// + /// 标记已读后的公告信息。 [HttpPost("{announcementId:long}/read")] [PermissionAuthorize("tenant-announcement:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantBillingsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantBillingsController.cs index aa306c8..9de398f 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantBillingsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantBillingsController.cs @@ -22,6 +22,7 @@ public sealed class TenantBillingsController(IMediator mediator) : BaseApiContro /// /// 分页查询账单。 /// + /// 租户账单分页结果。 [HttpGet] [PermissionAuthorize("tenant-bill:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -40,6 +41,7 @@ public sealed class TenantBillingsController(IMediator mediator) : BaseApiContro /// /// 账单详情。 /// + /// 租户账单详情。 [HttpGet("{billingId:long}")] [PermissionAuthorize("tenant-bill:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -58,6 +60,7 @@ public sealed class TenantBillingsController(IMediator mediator) : BaseApiContro /// /// 创建账单。 /// + /// 创建的账单信息。 [HttpPost] [PermissionAuthorize("tenant-bill:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -74,6 +77,7 @@ public sealed class TenantBillingsController(IMediator mediator) : BaseApiContro /// /// 标记账单已支付。 /// + /// 标记支付后的账单信息。 [HttpPost("{billingId:long}/pay")] [PermissionAuthorize("tenant-bill:pay")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantNotificationsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantNotificationsController.cs index aa11643..18c78ce 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantNotificationsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantNotificationsController.cs @@ -21,6 +21,7 @@ public sealed class TenantNotificationsController(IMediator mediator) : BaseApiC /// /// 分页查询通知。 /// + /// 租户通知分页结果。 [HttpGet] [PermissionAuthorize("tenant-notification:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -39,6 +40,7 @@ public sealed class TenantNotificationsController(IMediator mediator) : BaseApiC /// /// 标记通知已读。 /// + /// 标记已读后的通知信息。 [HttpPost("{notificationId:long}/read")] [PermissionAuthorize("tenant-notification:update")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] diff --git a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantsController.cs b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantsController.cs index 585ab2c..f3bc0a0 100644 --- a/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantsController.cs +++ b/src/Api/TakeoutSaaS.AdminApi/Controllers/TenantsController.cs @@ -22,6 +22,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 注册租户并初始化套餐。 /// + /// 注册的租户信息。 [HttpPost] [PermissionAuthorize("tenant:create")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -37,6 +38,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 分页查询租户。 /// + /// 租户分页结果。 [HttpGet] [PermissionAuthorize("tenant:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -52,6 +54,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 查看租户详情。 /// + /// 租户详情。 [HttpGet("{tenantId:long}")] [PermissionAuthorize("tenant:read")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -67,6 +70,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 提交或更新实名认证资料。 /// + /// 提交的实名认证信息。 [HttpPost("{tenantId:long}/verification")] [PermissionAuthorize("tenant:review")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -88,6 +92,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 审核租户。 /// + /// 审核后的租户信息。 [HttpPost("{tenantId:long}/review")] [PermissionAuthorize("tenant:review")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -106,6 +111,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 创建或续费租户订阅。 /// + /// 创建或续费的订阅信息。 [HttpPost("{tenantId:long}/subscriptions")] [PermissionAuthorize("tenant:subscription")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -125,6 +131,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 套餐升降配。 /// + /// 更新后的订阅信息。 [HttpPut("{tenantId:long}/subscriptions/{subscriptionId:long}/plan")] [PermissionAuthorize("tenant:subscription")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)] @@ -147,6 +154,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// /// 查询审核日志。 /// + /// 租户审核日志分页结果。 [HttpGet("{tenantId:long}/audits")] [PermissionAuthorize("tenant:read")] [ProducesResponseType(typeof(ApiResponse>), StatusCodes.Status200OK)] @@ -168,6 +176,7 @@ public sealed class TenantsController(IMediator mediator) : BaseApiController /// 配额校验并占用额度（门店/账号/短信/配送）。 /// /// 需在请求头携带 X-Tenant-Id 对应的租户。 + /// 配额校验结果。 [HttpPost("{tenantId:long}/quotas/check")] [PermissionAuthorize("tenant:quota:check")] [ProducesResponseType(typeof(ApiResponse), StatusCodes.Status200OK)]