api-design

Design RESTful APIs with resource naming, HTTP methods, and status codes.

Updated Mar 9, 2026
One-click install
npx skills add https://github.com/drxaibi/vibe-setup --skill api-design-drxaibi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/drxaibi/vibe-setup/tree/main/.github/skills/api-design
Command: npx skills add https://github.com/drxaibi/vibe-setup --skill api-design-drxaibi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to designing robust, scalable, and user-friendly REST APIs, ensuring consistency and adherence to best practices.

Core Features & Use Cases

  • Resource Naming Conventions: Establishes clear rules for URL structures and resource naming.
  • HTTP Method Semantics: Details the appropriate use of GET, POST, PUT, PATCH, and DELETE.
  • Status Codes: Guides the selection of correct HTTP status codes for various scenarios.
  • Response Formatting: Defines standard structures for success, collection, and error responses.
  • Pagination, Filtering, Sorting: Implements efficient data retrieval mechanisms.
  • Authentication & Authorization: Covers token-based auth and authorization patterns.
  • Rate Limiting: Strategies for managing API request volume.
  • Versioning: Best practices for API versioning.

Quick Start

Use the api-design skill to generate a standard JSON error response for a validation failure.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with proper resource naming and HTTP method semantics?

Designing a REST API requires establishing clear resource naming conventions for URL structures and applying correct semantics for HTTP methods like GET, POST, PUT, PATCH, and DELETE to ensure consistent web services.

What are the best practices for REST API status codes and response formatting?

REST API best practices involve selecting correct HTTP status codes for various scenarios and defining standard structures for success, collection, and error responses to create maintainable web services.

How do I implement pagination, filtering, and sorting in a RESTful API?

Implementing pagination, filtering, and sorting in a RESTful API provides efficient data retrieval mechanisms, ensuring production-ready backend development that handles large collections of resources effectively.

Does this API design guidance provide examples for backend development in TypeScript, Python, and Go?

Yes, this API design guidance focuses on practical implementation examples in TypeScript, Python, and Go, demonstrating patterns for token-based authentication, authorization, rate limiting, and versioning.

What is the best way to handle REST API versioning and rate limiting?

The best way to handle REST API versioning and rate limiting involves applying specific strategies for managing API request volume and maintaining versioning best practices to ensure production-ready web services.