What problem does it solve?
This Skill provides comprehensive guidance on designing and implementing RESTful APIs within a Laravel application, ensuring adherence to best practices for structure, security, and performance.
Core Features & Use Cases
- Route Conventions: Understand and implement both Inertia and API route patterns.
- RESTful Naming & Methods: Follow established conventions for resource naming, HTTP methods, and status codes.
- Pagination, Filtering & Sorting: Implement efficient data retrieval mechanisms.
- Error Handling & Versioning: Design clear error responses and versioning strategies.
- Authentication & Rate Limiting: Secure your APIs and manage traffic effectively.
- Use Case: When building a new API endpoint for managing user profiles, use this Skill to define the correct route, HTTP method, request/response structure, and implement authentication and authorization.
Quick Start
Use the api-design skill to generate a basic RESTful resource route for a 'products' resource in routes/api.php.