api-design

Design REST API patterns for resource naming, HTTP methods, and status codes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides comprehensive guidance and best practices for designing robust, scalable, and user-friendly REST APIs, addressing common pitfalls in resource naming, status codes, pagination, and error handling.

Core Features & Use Cases

  • RESTful Principles: Enforces conventions for resource naming, URL structure, and HTTP method semantics.
  • Standardized Responses: Defines clear patterns for success and error responses, including pagination and filtering.
  • Versioning Strategies: Outlines methods for API versioning and deprecation.
  • Use Case: When designing a new set of API endpoints for a user management system, use this Skill to ensure consistent resource naming (e.g., /api/v1/users), appropriate status codes (e.g., 201 Created for new users), and a clear error response format.

Quick Start

Use the api-design skill to generate a standard error response for a validation failure.

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

REST API resource naming best practices use plural nouns and hierarchical structures like `/api/v1/users` to enforce conventions. This Skill defines consistent URL structures and HTTP method semantics to ensure robust, scalable endpoint design.

How do I design standardized pagination, filtering, and sorting for API responses?

Design API pagination, filtering, and sorting by defining clear query parameter patterns for standardized responses. This Skill provides implementation patterns to structure large datasets efficiently and maintain consistent REST endpoint behavior.

Can I get REST API implementation examples in TypeScript, Python, and Go?

Yes, REST API implementation examples are available in TypeScript, Python, and Go. This Skill offers production-ready code snippets covering resource naming, status codes, and error response formats across these backend languages.

What's the best way to handle API versioning and deprecation strategies?

The best way to handle API versioning involves outlining clear methods for version management and deprecation within your URL structure or headers. This Skill outlines versioning strategies to maintain backward compatibility while transitioning endpoints.

Why does my API need specific HTTP status codes and error response formats?

Your API needs specific HTTP status codes and error response formats to provide clear client feedback, such as returning `201 Created` for new users. This Skill defines standardized patterns for success and error handling to avoid common integration pitfalls.

How do I implement authentication, authorization, and rate limiting in a REST API?

Implement REST API authentication, authorization, and rate limiting by enforcing access controls and request quotas at the endpoint level. This Skill provides design patterns to secure APIs and prevent abuse while maintaining scalable performance.