Agent-Skills.md

Agent Skills: Laravel API

Build REST endpoints with API Resources, Sanctum authentication, and versioned route groups in Laravel. Use when creating JsonResource classes, adding token-based auth, or defining rate-limited API routes. (triggers: routes/api.php, app/Http/Resources/**/*.php, resource, collection, sanctum, passport, cors)

UncategorizedID: hoangnguyen0403/agent-skills-standard/laravel-api

Repository

hoangnguyen0403/agent-skills-standard
HoangNguyen0403License: Apache-2.0
362103

Install this agent skill to your local

pnpm dlx add-skill https://github.com/HoangNguyen0403/agent-skills-standard/tree/HEAD/skills/laravel/laravel-api

Skill Files

Browse the full folder contents for laravel-api.

Download Skill

Loading file tree…

skills/laravel/laravel-api/SKILL.md

Skill Metadata

Name
laravel-api
Description
"Build REST endpoints with API Resources, Sanctum authentication, and versioned route groups in Laravel. Use when creating JsonResource classes, adding token-based auth, or defining rate-limited API routes. (triggers: routes/api.php, app/Http/Resources/**/*.php, resource, collection, sanctum, passport, cors)"

Laravel API

Priority: P1 (HIGH)

Workflow: Create a New API Endpoint

  1. Generate resource — php artisan make:resource UserResource.
  2. Define toArray() — Specify exact output fields; never return raw models.
  3. Add route — Register in routes/api.php with version prefix and throttle middleware.
  4. Secure with Sanctum — Apply auth:sanctum middleware to protected routes.
  5. Return proper status codes — 201 for Created, 422 for Validation, 204 for No Content.

API Resource Example

See implementation examples for a complete API Resource with collection usage.

Implementation Guidelines

API Resources & Transformation

  • API Resources: Always use ApiResource classes extending JsonResource for data transformation.
  • Collections: Use UserResource::collection($users) for lists. Never use response()->json($model) or return raw models directly.
  • Data Definition: Implement toArray($request) to define specific output fields and prevent sensitive data leakage.
  • Generation: Use php artisan make:resource UserResource to scaffold new resources.

Authentication & Security

  • Sanctum: Use auth:sanctum middleware in routes/api.php for SPAs or mobile app authentication.
  • Traits: Add the HasApiTokens trait to your User model to enable token-based authentication.
  • Token Management: Issue tokens using $user->createToken('token-name')->plainTextToken.
  • OAuth2: Use Passport only if standard OAuth2 flows or client grants are required.

Routing & Performance

  • Versioning: Group routes with Route::prefix('v1')->group(...) and use versioned namespaces (e.g., App\Http\Controllers\Api\V1).
  • Rate Limiting: Define RateLimiter::for('api', ...) using Limit::perMinute(60) in AppServiceProvider.
  • Middleware: Apply the throttle:api middleware to route groups in routes/api.php.
  • Status Codes: Return 201 for Created, 422 for Validation errors, and 204 for No Content.

Anti-Patterns

  • No raw model returns: Use API Resources; prevents data leakage.
  • No response()->json(): Use API Resource classes instead.
  • No session auth for APIs: Use Sanctum or Passport tokens.
  • No static URLs in JSON: Use route names or HATEOAS links.

References