api-design

Provide REST API design guidelines covering resource naming, HTTP methods, status codes, and versioning.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/ninyawee/dotfiles --skill api-design-ninyawee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/ninyawee/dotfiles/tree/main/dot_claude/skills/api-design
Command: npx skills add https://github.com/ninyawee/dotfiles --skill api-design-ninyawee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to designing RESTful APIs that are consistent, maintainable, and developer-friendly, reducing integration friction and improving API usability.

Core Features & Use Cases

  • Resource Naming Conventions: Establishes clear rules for URL structures and resource naming.
  • HTTP Method & Status Codes: Details the semantic use of HTTP methods and appropriate status codes for various scenarios.
  • Pagination, Filtering, Sorting: Offers strategies for handling large datasets efficiently.
  • Error Handling & Versioning: Guides on creating informative error responses and managing API evolution.
  • Use Case: When designing a new set of endpoints for a user management system, use this Skill to ensure all resources are named correctly, errors are handled consistently, and pagination is implemented effectively.

Quick Start

Use the api-design skill to generate a GET endpoint for retrieving a list of products with pagination and filtering by price.

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 consistent resource naming and URL structure?

REST API resource naming requires establishing clear conventions for URL structures and resource identification. This Skill provides comprehensive guidelines to ensure your endpoints are consistent, maintainable, and reduce integration friction for developers.

What HTTP status codes should I use for different REST API scenarios?

HTTP status codes in REST APIs must semantically match the operation outcome, differentiating between success, client errors, and server faults. This Skill details appropriate status codes for various scenarios alongside the correct semantic use of HTTP methods.

How to implement pagination, filtering, and sorting for large datasets in a REST API?

Implementing pagination, filtering, and sorting in a REST API requires specific strategies to handle large datasets efficiently without overwhelming the client. This Skill offers established patterns to retrieve and manage subsets of data effectively.

What is the best way to format error responses and handle API versioning in web services?

Error responses and API versioning in web services are best handled by creating informative error payloads and managing API evolution systematically. This Skill guides you through establishing robust error handling and versioning conventions.

Can I use these API design patterns with TypeScript, Python, and Go backends?

These API design patterns are fully compatible with TypeScript, Python, and Go backends. The Skill provides implementation patterns and conventions for URL structures and response envelopes across these specific languages.

When do I need rate limiting and authentication for production-ready REST APIs?

Rate limiting and authentication are needed for production-ready REST APIs to control traffic flow and secure access to resources. This Skill covers these implementation patterns to ensure your web services are robust and scalable.