api-design

Design and validate RESTful API specifications covering naming, status codes, pagination, and versioning.

2|Updated Apr 14, 2026
One-click install
npx skills add https://github.com/klu-dev/porting-ecc-to-vscode --skill api-design-klu-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/klu-dev/porting-ecc-to-vscode/tree/main/.github/skills/api-design
Command: npx skills add https://github.com/klu-dev/porting-ecc-to-vscode --skill api-design-klu-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the complexities of designing and implementing RESTful APIs, providing a comprehensive guide to best practices and patterns, ensuring high-quality, maintainable APIs.

Core Features & Use Cases

  • Resource Design: Offers guidelines for URL structure, naming rules, and best practices.
  • HTTP Methods and Status Codes: Provides reference and best practices for HTTP methods and status codes.
  • Response Format: Standardizes JSON response formats, including success, error, and collection responses.
  • Pagination: Covers offset-based and cursor-based pagination strategies.
  • Filtering, Sorting, and Search: Details how to implement filtering, sorting, and full-text search.
  • Authentication and Authorization: Discusses token-based auth and authorization patterns.
  • Rate Limiting: Explains how to implement and handle rate limiting.
  • Versioning: Outlines strategies for URL path and header versioning.
  • Implementation Patterns: Provides examples in TypeScript, Python, and Go.
  • API Design Checklist: Ensures that all essential aspects of API design are considered before deployment.

Quick Start

Run the api-design skill to review the API design patterns for a new REST API project.

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 pagination?

To design a REST API with proper structure, follow best practices for resource naming, pagination, and response formatting. This ensures maintainable APIs by standardizing offset-based and cursor-based pagination alongside JSON collection responses.

What HTTP status codes and methods should I use for my RESTful API?

Selecting correct HTTP status codes and methods is critical for RESTful API design. Use standard HTTP methods for resource operations and apply appropriate status codes to clearly communicate success, client errors, or server failures.

What's the best way to implement rate limiting, authentication, and versioning in a REST API?

The best way to implement REST API security and versioning involves using token-based authentication patterns, defining rate limiting rules, and applying URL path or header versioning strategies to manage API evolution effectively.

How do I standardize error responses and JSON formats for a REST API?

Standardize REST API error responses by defining consistent JSON formats for success, error, and collection outputs. This includes detailing error specifics and applying best practices for response payloads across all endpoints.

Does this REST API design approach support implementation in TypeScript, Python, and Go?

Yes, this REST API design approach supports implementation in TypeScript, Python, and Go. It provides concrete implementation patterns and an API design checklist to ensure all essential aspects are considered before deployment.

When should I use cursor-based pagination instead of offset-based pagination in an API?

Use cursor-based pagination instead of offset-based pagination in an API when dealing with large, dynamic datasets. Cursor-based strategies prevent performance issues and data inconsistencies that often occur with offset limits.