api-design

I'm not able to find a reliable mapping for that phrase.

Updated Feb 8, 2026
One-click install
npx skills add https://github.com/bramato/laravel-react-plugins --skill api-design-bramato
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/bramato/laravel-react-plugins/tree/main/laravel-react/skills/api-design
Command: npx skills add https://github.com/bramato/laravel-react-plugins --skill api-design-bramato

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design RESTful API routes in Laravel for both Inertia and API clients?

RESTful API routes in Laravel should follow resource naming conventions using standard HTTP methods. This Skill guides implementing distinct route patterns for Inertia and API clients, ensuring proper endpoint structure and maintainability for both web and external consumers.

What's the best way to handle Laravel API pagination, filtering, and sorting?

Laravel API pagination, filtering, and sorting are handled using efficient data retrieval mechanisms. This Skill details best practices for implementing these query parameters to ensure scalable and maintainable data endpoints.

How do I implement authentication and rate limiting for a Laravel RESTful API?

Authentication and rate limiting for a Laravel RESTful API are implemented using Laravel Sanctum. This Skill provides guidance on securing endpoints and managing traffic effectively to prevent abuse and ensure robust API security.

What HTTP status codes and error responses should a Laravel API return?

A Laravel API should return clear error responses with appropriate HTTP status codes following established RESTful conventions. This Skill outlines how to design consistent error payloads and implement versioning strategies for maintainable endpoints.

Does this API design guidance cover versioning strategies for Laravel endpoints?

Yes, API design guidance covers versioning strategies for Laravel endpoints. This Skill details how to implement versioning alongside error handling, route conventions, and resource naming to ensure scalable and maintainable APIs.