SuperAPI AI 工具集

laravel-api

编程与开发

查看项目

更新于 10-26 17:21

技能介绍

用途

laravel-api 是一个面向 Laravel 项目的 API 开发技能,用于指导构建 RESTful API。依据其资料,核心目标是用 Laravel 的 API Resources 做响应转换、用 Sanctum 做认证,并围绕控制器、Form Request 校验、版本化路由、限流、分页和外部 HTTP 客户端形成一致的开发规范。

主要能力

技能以「组件—用途」表的形式列出覆盖范围:Controllers(处理请求并委托给服务层)、Form Requests(校验输入并做操作授权)、API Resources(将模型转换为 JSON)、Middleware(认证、限流、CORS)、Routes(分组版本化端点)、Pagination(偏移与游标分页)、HTTP Client(消费外部 API)。

它同时给出一组关键规则:始终使用 API Resources,不直接返回 Eloquent 模型;路由加 /v1/、/v2/ 等版本前缀;所有输入通过 Form Requests 校验而非内联校验;按路由配置限流;保持响应结构一致并使用正确的状态码;控制器保持轻量、业务逻辑放到服务层;分页前用 with() 预加载以避免 N+1。

使用方式

资料描述了一套强制性的代理工作流:在任何实现之前并行启动 3 个代理,分别用于分析现有 API 模式(explore-codebase)、通过 Context7 核实 Laravel API 文档(research-expert)、查询 API Resources 与 Sanctum 模式(mcp__context7__query-docs);实现完成后运行 sniper 进行验证。

参考指南按主题组织,包括 Routing、Controllers、Middleware、Validation、Requests、Responses、Pagination、Rate Limiting、HTTP Client、URLs、Strings、Redirects。代码模板包括 ApiController.php.md(含服务层的完整 CRUD 控制器)、api-routes.md(带中间件的版本化路由)、routing-examples.md、FormRequest.php.md、validation-rules.md、ApiResource.php.md(含关联关系)、HttpClientService.php.md(可复用 HTTP 客户端服务)。

快速参考中给出的代码示例包括:

return PostResource::collection($posts); return PostResource::make($post); return PostResource::make($post)->response()->setStatusCode(201); Route::middleware('throttle:60,1')->group(fn () => ...); return PostResource::collection(Post::paginate(15));

适用场景

适合使用 Laravel 创建 API 端点、用 API Resources 转换响应、处理 API 认证、限流或版本化的开发任务。功能矩阵中标注支持 RESTful 控制器、API Resources、Form Request 校验、路由版本化、路由模型绑定、中间件、限流、分页、游标分页、HTTP 客户端、签名 URL 和 JSON 响应。

限制

资料未提供该技能的安装命令、收费方式、运行平台或性能数据,这些事实暂未提供。技能中涉及的 Context7 查询、explore-codebase、sniper 等代理属于其工作流要求,具体可用性取决于运行环境。JSON:API 合规相关内容不在本技能内,资料指向 laravel-jsonapi 技能。Laravel 13 的 #[Collects] 与 #[PreserveKeys] 属性说明仅限资料描述的范围。