api-design

Guide RESTful API and GraphQL schema design with versioning and validation.

Updated Feb 26, 2026
One-click install
npx skills add https://github.com/dgkngk/super-kit --skill api-design-dgkngk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/dgkngk/super-kit/tree/main/skills/meta/api-design
Command: npx skills add https://github.com/dgkngk/super-kit --skill api-design-dgkngk

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides guidance on designing effective RESTful APIs and GraphQL schemas, helping developers avoid common pitfalls and build scalable, maintainable services.

Core Features & Use Cases

  • RESTful Principles: Covers resource naming, HTTP status codes, response formats, pagination, filtering, and sorting.
  • API Versioning: Demonstrates strategies for managing API versions.
  • Rate Limiting & Validation: Includes examples for implementing rate limiting and input validation using libraries like express-rate-limit and zod.
  • Use Case: When starting a new project, use this Skill to ensure your API design adheres to industry best practices from the outset, covering everything from endpoint structure to error handling.

Quick Start

Use the api-design skill to understand how to structure a RESTful GET endpoint for retrieving a list of users with pagination and filtering.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for RESTful API design?

RESTful API design best practices involve standardized resource naming, correct HTTP status codes, consistent response structures, and efficient pagination, filtering, and sorting. Adhering to these principles ensures your web services remain scalable and maintainable.

How do I implement rate limiting and input validation in an API?

To implement rate limiting and input validation in an API, use libraries like express-rate-limit for controlling request volume and zod for schema validation. These tools prevent abuse and ensure incoming data matches expected formats.

What is the best way to handle API versioning?

API versioning manages changes to your service without breaking existing clients. Effective strategies involve standardized approaches to endpoint structure and version management, ensuring smooth transitions and backward compatibility for maintainable web services.

How do I structure a RESTful endpoint for retrieving users with pagination and filtering?

Structuring a RESTful endpoint for retrieving users requires applying standardized resource naming and query parameters for pagination and filtering. This approach returns a consistent response structure, ensuring efficient data retrieval and scalable API design.

Does this API design guidance cover GraphQL schemas?

Yes, this API design guidance covers GraphQL schemas alongside RESTful APIs. It provides comprehensive instructions for designing robust schemas, ensuring standardized and efficient development practices across both architectural styles for maintainable web services.

Why do I need standardized API response structures and HTTP status codes?

Standardized API response structures and HTTP status codes are needed to create predictable and maintainable web services. They provide clear communication of success and error states, ensuring clients can handle responses efficiently and scale effectively.