skills.rest
mbadoz
mbadozCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST APIs with conventions for naming, status codes, pagination, and versioning.

2|Updated Apr 5, 2026
Search Tags:#versioning#rest#error-handling#pagination#api-design#http-status-codes
One-click install
npx skills add https://github.com/mbadoz/mbadoz-skills --skill api-design-mbadoz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/mbadoz/mbadoz-skills/tree/main/plugins/built-planner/skills/built-planner/references/skills/api-design
Command: npx skills add https://github.com/mbadoz/mbadoz-skills --skill api-design-mbadoz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design patterns help teams create consistent, scalable, and developer-friendly interfaces by standardizing naming, responses, and versioning.

Core Features & Use Cases

  • Resource Design: URL structures using plural nouns, nested resources, and avoidance of verbs in paths.
  • HTTP Methods & Status Codes: semantic usage, including 200/201/204, 400/422/404, and proper error formats.
  • Versioning, Pagination, Filtering & Security: strategies to evolve APIs safely while supporting pagination and query capabilities.
  • Example Scenarios: designing public APIs for partners and internal services with clear contracts and error handling.

Quick Start

Start by applying REST design conventions to your API, including resource naming, status codes, pagination, filtering, and versioning.

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 uses plural nouns, nested resources, and avoids verbs in URL paths to create consistent, scalable interfaces. This convention standardizes endpoint structures for public and internal services, ensuring clear contracts for developers consuming the API.

How do I design consistent error handling and HTTP status codes for my API?▼

Error handling in API design requires semantic HTTP status codes, including 200/201/204 for success and 400/422/404 for errors, paired with proper error formats. Standardizing these responses ensures developer-friendly interfaces and clear API contracts.

When should I implement API versioning strategies for REST services?▼

API versioning is needed to evolve REST services safely while supporting backward compatibility. Implementing versioning strategies allows teams to introduce changes to resource naming, pagination, and filtering without breaking existing public or internal API consumers.

How do I add pagination and filtering to REST API endpoints?▼

Pagination and filtering are added to REST APIs through standardized query capabilities and URL structures. These conventions support scalable data retrieval across public and internal APIs, allowing clients to request specific resource subsets efficiently.

Can I use these REST API design patterns for both public and internal services?▼

Yes, REST API design patterns apply to both public partner APIs and internal services. The conventions for resource naming, authentication patterns, error handling, and rate limiting ensure developer-friendly interfaces and clear contracts across different integration contexts.

Related Skills

Explore More Software Engineering Skills→
gugug168gugug168

api-design

Define REST API conventions for naming, methods, status codes, and pagination.

Community
Intermediate
diendhdiendh

rest-api-expert

Design REST API endpoints, versioning, error handling, and OpenAPI specs.

Community
Advanced
microwindmicrowind
65

API网关设计

Design API gateways for routing, security, and traffic management in microservices.

Official
Advanced
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced