ecc-api-design

Define REST API design conventions for endpoints, errors, and versioning.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to designing consistent, developer-friendly REST APIs, addressing common challenges in resource naming, HTTP methods, status codes, pagination, filtering, sorting, error handling, versioning, and rate limiting.

Core Features & Use Cases

  • Standardized API Design: Enforces best practices for resource URLs, HTTP method semantics, and status code usage.
  • Advanced Data Handling: Implements strategies for efficient pagination (offset and cursor-based), flexible filtering, and sorting.
  • Robust Error Management: Defines a clear structure for API error responses, including detailed error codes and messages.
  • Versioning and Rate Limiting: Outlines recommended approaches for API versioning and rate limiting to ensure stability and manage usage.
  • Use Case: When designing a new set of API endpoints for a user management system, use this Skill to ensure all endpoints follow RESTful conventions, handle data efficiently, and provide clear feedback through status codes and error messages.

Quick Start

Follow the REST API design conventions outlined in this skill when creating new API endpoints.

Frequently Asked Questions about ecc-api-design

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

FAQPage Schema
What are the best practices for REST API resource naming and HTTP methods?

REST API resource naming best practices involve using plural nouns for endpoints and applying standard HTTP methods like GET, POST, PUT, and DELETE to ensure consistent web services. This skill provides conventions to standardize endpoint design and enforce proper method semantics.

How do I handle pagination, filtering, and sorting in REST API design?

Handle pagination, filtering, and sorting in REST API design by implementing offset or cursor-based pagination strategies alongside flexible query parameters. This skill outlines conventions for efficient data handling to manage large datasets returned from web services.

What is the standard structure for REST API error responses and status codes?

The standard structure for REST API error responses includes clear error codes, detailed messages, and appropriate HTTP status codes. This skill defines a robust error management structure to provide clear feedback for API endpoint failures.

How do I implement API versioning and rate limiting for web services?

Implement API versioning and rate limiting for web services by following recommended architectural patterns that ensure stability and manage usage. This skill outlines specific approaches to version endpoints and restrict request rates for backend development.

Does this REST API design guide work for reviewing existing backend endpoints?

Yes, this REST API design guide works for reviewing existing backend endpoints by checking resource naming, status codes, and error handling against established conventions. It requires an understanding of web API principles to evaluate consistency.

When do I need cursor-based pagination instead of offset pagination in REST APIs?

You need cursor-based pagination instead of offset pagination in REST APIs when handling large, frequently updated datasets to prevent data skipping. This skill provides strategies for implementing both pagination methods based on your data requirements.