skills.rest
hieuck
hieuckCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST APIs with naming conventions, HTTP semantics, and pagination.

Updated Mar 21, 2026
Search Tags:#versioning#rest#error-handling#pagination#design-patterns#api-design
One-click install
npx skills add https://github.com/hieuck/Pro5ChromeManager --skill api-design-hieuck
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/hieuck/Pro5ChromeManager/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/hieuck/Pro5ChromeManager --skill api-design-hieuck

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent API design creates integration friction, unclear error handling, and fragmented versioning across teams. This Skill provides a structured approach to REST API design with standardized resource naming, HTTP semantics, and scalable patterns.

Core Features & Use Cases

  • Resource naming conventions and URL structure for scalable, readable APIs
  • HTTP methods, status codes, pagination, filtering, and versioning patterns
  • Consistent error handling, rate limiting, and authentication patterns for public and partner APIs
  • Use Case: Design and review a new service with clear contracts, documented responses, and compatible versioning

Quick Start

Design a REST API for a new resource that uses versioned endpoints, proper pagination, and robust error handling.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with consistent pagination and error handling?▼

REST API design solves integration friction by standardizing resource naming, HTTP semantics, and scalable patterns. This ensures clear contracts, documented responses, and compatible versioning across teams.

What HTTP status codes should I use for REST API error handling?▼

REST API error handling applies proper HTTP semantics and status codes to provide consistent responses. Standardized patterns ensure clear contracts and documented responses for public and partner-facing services.

What is the best way to version REST API endpoints?▼

Version REST API endpoints using structured versioning patterns to maintain compatibility across public and partner services. This approach prevents fragmented versioning and ensures clear API contracts.

How do I structure resource naming and URL conventions for a scalable REST API?▼

Structure REST API resource naming and URL conventions using standardized patterns for scalable and readable endpoints. This provides a structured approach to URL structure and resource naming.

Can I use this approach to design rate limiting and authentication for partner APIs?▼

Yes, this approach designs rate limiting and authentication patterns specifically for public and partner APIs. It ensures consistent error handling and scalable patterns for partner-facing services.

Related Skills

Explore More Software Engineering Skills→
AgentientAgentient
2

mcp-pydantic-tool-definition

Define MCP tool schemas with Pydantic models and strict validation.

Official
Advanced
Adelie-SquadAdelie-Squad
17

api-developer

Design API contracts and generate OpenAPI 3.0 documentation.

Official
Advanced
altrupetsaltrupets

API Gateway & Rate Limiting

Implement API Gateway patterns and rate limiting with Kong or Nginx.

Official
Intermediate
iludeilude
8

api-design-patterns

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

Community
Advanced