api-design

Standardize REST API design patterns across services with resource naming, HTTP methods, and versioning.

1|1|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/PedroHBO/opencode-config-skills --skill api-design-pedrohbo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/PedroHBO/opencode-config-skills/tree/main/skills/api-design
Command: npx skills add https://github.com/PedroHBO/opencode-config-skills --skill api-design-pedrohbo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Establishes a standardized approach to REST API design that improves consistency, reduces integration friction, and accelerates delivery across services.

Core Features & Use Cases

  • Resource naming and URL conventions (plural nouns, kebab-case, no verbs)
  • HTTP methods, status codes, and response formats that align with clients and tooling
  • Pagination, filtering, and sorting patterns, plus search when needed
  • Authentication, authorization, versioning, and rate limiting with OpenAPI-compatible schemas
  • Guidance for implementation patterns and governance to scale API programs

Quick Start

Design a new REST API following this skill's conventions for endpoints, responses, and error handling.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the standard REST API design patterns for resource naming and URL conventions?

Standard REST API design patterns use plural nouns, kebab-case formatting, and exclude verbs from URLs to ensure consistent resource naming across services. This approach reduces integration friction and accelerates delivery by providing a uniform interface for client interactions.

How do I implement pagination, filtering, and sorting in a REST API?

Implement pagination, filtering, and sorting in REST APIs by applying standardized query parameter patterns to manage large datasets. These patterns align client tooling with server responses, ensuring scalable data retrieval when clients request specific subsets of resources.

What is the best way to structure error handling and HTTP status codes in a REST API?

Structure REST API error handling by enforcing standardized error formats and aligning HTTP status codes with client actions. This ensures consistent communication of failures, improves integration debugging, and aligns response formats with OpenAPI-compatible schemas for production readiness.

How does versioning and authentication work in scalable REST API design?

Versioning and authentication in scalable REST APIs work by applying standardized version strategies and rate limiting alongside authentication protocols. This secures endpoints and manages changes without breaking existing client integrations across multiple services.

Can I use these REST API conventions for governing multiple microservices?

Yes, you can use these REST API conventions to govern multiple microservices by enforcing consistent schemas, version strategies, and implementation patterns. This governance scales API programs by standardizing design from initial development through final deployment.