api-design

Design REST APIs with consistent resource naming, status codes, pagination, filtering, and versioning.

86|21|Updated Feb 9, 2026
One-click install
npx skills add https://github.com/Jamkris/everything-gemini-code --skill api-design-jamkris
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Jamkris/everything-gemini-code/tree/main/skills/api-design
Command: npx skills add https://github.com/Jamkris/everything-gemini-code --skill api-design-jamkris

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provide clear, standardized guidelines for building reliable, scalable REST APIs, reducing ambiguity in endpoint design and error handling.

Core Features & Use Cases

  • Resource naming conventions, URL structures, and HTTP method semantics to maintain consistency across services.
  • Pagination, filtering, sorting, and versioning strategies to support robust data access and upgrade paths.
  • Error formats, authentication/authorization patterns, and rate limiting practices to improve security and resilience in production.

Quick Start

Design the first API for a new service by applying resource-based URLs, standard HTTP methods, and consistent status codes to enable predictable client behavior.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST APIs with consistent resource naming and HTTP methods?▼

Design REST APIs by applying resource-based URLs and standard HTTP method semantics to maintain endpoint consistency. This enforces predictable client behavior across services by standardizing URL structures and HTTP method usage.

What's the best way to handle pagination, filtering, and sorting in REST APIs?▼

Handle REST API pagination, filtering, and sorting by applying structured data access strategies. These patterns support robust data retrieval and ensure clients can efficiently navigate large datasets across your service endpoints.

How do I implement structured error handling and status codes in a REST API?▼

Implement structured REST API error handling by enforcing consistent status codes and standardized error formats. This reduces ambiguity in endpoint design and improves production resilience by providing predictable client feedback.

Can I use this REST API design approach for both internal and public partner schemas?▼

Yes, you can use this REST API design approach for public, partner, or internal API schemas. It applies standardized resource naming, versioning, and authentication practices across various service contexts and scales.

When should I apply versioning strategies and rate limiting to my REST API?▼

Apply REST API versioning strategies and rate limiting when establishing upgrade paths and ensuring production resilience. These practices protect services from excessive load and provide clear data access migration routes for clients.

Why do I need clear authentication and authorization patterns in REST API design?▼

Clear REST API authentication and authorization patterns are needed to improve security across services. Enforcing these structured practices ensures proper access control and protects endpoints from unauthorized usage.