skills.rest
tony-ng-vn
tony-ng-vnCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

ecc-api-design

Design and review REST API patterns for resource naming, status codes, pagination, and versioning.

Updated Apr 5, 2026
Search Tags:#best practices#authentication#api design#rest api#pagination#status codes#http methods
One-click install
npx skills add https://github.com/tony-ng-vn/Resume-agent --skill ecc-api-design-tony-ng-vn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ecc-api-design
Source: https://github.com/tony-ng-vn/Resume-agent/tree/main/.agents/skills/ecc-api-design
Command: npx skills add https://github.com/tony-ng-vn/Resume-agent --skill ecc-api-design-tony-ng-vn

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers design and review REST API patterns, ensuring consistency, developer-friendliness, and adherence to best practices.

Core Features & Use Cases

  • API Design Patterns: Offers guidelines for resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting.
  • Resource Design: Includes rules for URL structure and naming conventions.
  • HTTP Methods and Status Codes: Provides a reference for method semantics and status code usage.
  • Response Format: Describes success and error response formats.
  • Pagination: Explains offset-based and cursor-based pagination methods.
  • Filtering, Sorting, and Search: Covers filtering, sorting, and full-text search capabilities.
  • Authentication and Authorization: Discusses token-based auth and authorization patterns.
  • Rate Limiting: Describes rate limiting headers and tiers.
  • Versioning: Offers strategies for URL path and header versioning.
  • Implementation Patterns: Provides examples in TypeScript (Next.js), Python (Django), and Go.
  • API Design Checklist: A comprehensive checklist for ensuring API quality.

Quick Start

Use the ecc-api-design skill to review the API design for the 'ecommerce' project and generate a report on best practices.

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 URL structure?▼

REST API resource naming best practices involve using logical, consistent URL structures and naming conventions for endpoints. This skill provides specific rules for URL structure design to ensure developer-friendliness and adherence to standards.

How do I design pagination and filtering for a REST API?▼

Design REST API pagination and filtering by implementing offset-based or cursor-based pagination methods alongside dedicated sorting and full-text search capabilities. This skill outlines these patterns to handle large datasets efficiently.

Which HTTP status codes and error response formats should my REST API use?▼

REST APIs should use standard HTTP status codes and structured error response formats to communicate outcomes clearly. This skill provides a reference for method semantics, status code usage, and error response structuring.

What is the best way to implement versioning and rate limiting in REST API design?▼

The best way to implement REST API versioning and rate limiting involves using URL path or header strategies alongside specific rate limiting headers and tiers. This skill details these patterns to manage API traffic and iterations.

Does this REST API design skill support implementation patterns for Python, Go, and TypeScript?▼

Yes, this REST API design skill supports implementation patterns for TypeScript (Next.js), Python (Django), and Go. It provides concrete examples in these languages alongside a comprehensive API design checklist.

How do I review an existing REST API for best practices and consistency?▼

Review an existing REST API for best practices by evaluating resource naming, authentication, status codes, and pagination against established guidelines. This skill generates reports on best practice adherence for API maintenance workflows.

Related Skills

Explore More Software Engineering Skills→
VeradelaCruzVeradelaCruz

api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Community
Intermediate
CuriousLearnerCuriousLearner
27

openapi-generator

Generate OpenAPI 3.0 specifications and documentation from existing codebases.

Community
Advanced
vertivolatamvertivolatam
1

API Gateway & Rate Limiting

Implement API Gateways with Kong and Nginx rate limiting strategies.

Official
Advanced
iludeilude
8

api-design-patterns

Design REST and GraphQL APIs with language-agnostic patterns for routes, schemas, and specs.

Community
Advanced