该技能用于在 ABP Framework 中设计一致、可预测的 REST API 响应包装模式,适合需要统一 API 响应契约、标准化成功与错误格式、为响应添加元数据(分页、时间、版本)、以及为 Web、移动端和第三方等多种客户端提供 API 的场景。
主要能力包括:基础 ResponseModel 泛型与非泛型版本,提供 Success/Failure 静态方法;扩展的 ApiResponse,包含 Meta 元数据(版本、时间戳、请求 ID、处理耗时)和 ApiError 列表;分页响应 PagedApiResponse 与 PaginationInfo,提供总条数、页码、页大小、总页数、是否有上/下一页;错误响应模式,如 ValidationErrorResponse 与 FieldError;异常过滤器 ApiExceptionFilter,将实体未找到、验证、业务、未授权等异常映射为统一响应与状态码;控制器模式与 ToActionResult 扩展方法;以及 Swagger/OpenAPI 通用错误响应文档配置。
使用方式上,技能以 C# 代码示例展示在 Application.Contracts 中定义模型、在 AppService 中返回包装结果、在 Controller 中转换为对应 HTTP 状态码,并给出基本 CRUD、分页查询与批量操作的实现示例。必要命令与代码保持原样。
限制:资料未提供安装命令、包名、依赖版本、性能数据、收费信息及具体平台要求,相关内容暂未提供;示例基于 ABP Framework,需在相应项目结构中参考使用。