Larasonic REST API实战：Sanctum令牌认证+Scribe自动生成文档的5步走法

Larasonic REST API实战Sanctum令牌认证Scribe自动生成文档的5步走法【免费下载链接】larasonic-vueThe Ultimate Laravel Starter Kit for Modern SaaS (VILT) with Shadcn Components (Vue, Inertia Shadcn)项目地址: https://gitcode.com/gh_mirrors/la/larasonic-vueLarasonic 是一个面向现代 SaaS 的 Laravel 起始套件VILT 技术栈 Shadcn Vue 组件内置REST API 实战所需的全部能力用Laravel Sanctum 令牌认证保护接口再用Scribe 自动生成 API 文档从写代码到交付文档一步到位。本文带你用 5 步快速跑通这套流程新手也能轻松上手 。第 1 步一键安装环境准备Larasonic 把「建库、装依赖、生成 API 文档」都写进了 Composer 的setup脚本里克隆仓库后只需一条命令git clone https://gitcode.com/gh_mirrors/la/larasonic-vue cd larasonic-vue composer setupsetup脚本见 composer.json会自动完成生成应用密钥、初始化数据库、构建前端资源并执行php artisan scribe:generate生成 API 文档。也就是说文档生成已经被整合进安装流程这是本套件很贴心的一个设计。第 2 步一条 apiResource声明全部接口打开routes/api.php你会发现所有用户接口只用了一行代码Route::apiResource(user, ApiUserController::class)-middleware(auth:sanctum);这一行同时完成了两件事自动注册/api/user的增删改查 5 个标准 REST 端点给整组路由挂上auth:sanctum中间件——未携带有效令牌的请求一律返回 401这一点在 tests/Feature/Controllers/ApiUserControllerTest.php 中有专门的测试保障。第 3 步在控制台创建 Sanctum 令牌拿到访问权不需要手写任何认证代码。登录你的 Larasonic 应用后点击右上角用户菜单 → API token参考 config/scribe.php 中写给 API 使用者的提示即可创建一个 Personal Access Token。创建时还能勾选令牌权限例如read、update、delete实现细粒度授权——一个只读令牌即使被泄露也无法修改数据。测试用例 CreateApiTokenTest.php 完整演示了这个流程创建令牌后立即校验can(read)为 true、can(delete)为 false。调用接口时只需在请求头带上 Bearer 令牌curl -H Authorization: Bearer {你的令牌} \ http://localhost:8000/api/user第 4 步控制器里的权限二次防线令牌只解决「你是谁」「你能做什么」则由 app/Http/Controllers/ApiUserController.php 中的Gate 授权把关。每个方法都会先调用Gate::authorize()接口动作权限要求GET /api/user列出用户viewAnyPOST /api/user创建用户createGET /api/user/{id}查看用户viewPUT /api/user/{id}更新用户updateDELETE /api/user/{id}删除用户delete配合多团队Team功能admin / editor / reader 三种角色各司其职令牌权限 团队角色形成双重防护SaaS 项目最看重的安全边界一次到位。第 5 步Scribe 自动生成文档并在线调试改完接口后运行一条命令文档即刻更新php artisan scribe:generate然后在浏览器访问/docs即可。Larasonic 对 Scribe 的预配置config/scribe.php相当实用仅收录api/*路由文档聚焦不杂乱routes 匹配规则文档需要 Sanctum 登录才能访问middleware [web, auth:sanctum]配置位置避免接口文档裸奔Try It Out 在线调试已开启配置位置API 使用者可以直接在页面上填参数发请求额外导出Postman 集合团队协作调试更方便。 小技巧在控制器的 docblock 里写上group、authenticated等注解如 ApiUserController 所示Scribe 会自动把它们组织成文档分组并标注认证要求几乎零成本获得专业的 API 文档。写在最后5 步回顾✅ 安装 → ✅ 声明路由 → ✅ 创建令牌 → ✅ 权限授权 → ✅ 生成文档。Larasonic 把 Sanctum 令牌认证与 Scribe 文档生成预装进 Laravel SaaS 起始套件让你把精力花在业务功能上而不是重复搭建基础架构。如果你想扩展新的资源比如 products、orders照着apiResourceGate docblock 注解的套路复制一份即可REST API 能力即刻扩展 。【免费下载链接】larasonic-vueThe Ultimate Laravel Starter Kit for Modern SaaS (VILT) with Shadcn Components (Vue, Inertia Shadcn)项目地址: https://gitcode.com/gh_mirrors/la/larasonic-vue创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考