api-design

Applies REST API design patterns for naming, status codes, pagination, and versioning.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design often suffers from inconsistencies in resource naming, error handling, pagination, and versioning across endpoints, leading to poor developer experience and unstable integrations.

Core Features & Use Cases

  • Consistent resource naming and URL conventions (plural nouns, kebab-case)
  • Standardized HTTP methods, status codes, and error responses
  • Pagination strategies (offset and cursor) with clear boundaries
  • Flexible filtering, sorting, and full-text search guidelines
  • Versioning strategy and rate-limiting recommendations for production APIs
  • Real-world use cases: building public/private APIs, partner integrations, and public docs

Quick Start

Define a REST API contract for a new service that follows resource naming, proper status codes, pagination, filtering, versioning, and rate limiting.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design consistent REST API resource naming and URL conventions?

REST API resource naming uses plural nouns and kebab-case for URL conventions to ensure consistency. Applying these established patterns solves endpoint inconsistencies, leading to a stable developer experience and predictable integrations across services.

What are the best practices for REST API pagination and filtering?

REST API pagination best practices involve implementing offset and cursor strategies with clear boundaries. You should also apply flexible filtering, sorting, and full-text search guidelines to ensure endpoints remain efficient and production-ready under large data loads.

How should I structure error responses and HTTP status codes in a REST API?

Error responses and HTTP status codes in a REST API should follow standardized patterns for consistency. Enforcing specific validation rules for status codes and structured error messages across services delivers stable integrations and improves overall developer experience.

What is the best way to implement API versioning and rate limiting for production?

API versioning and rate limiting for production APIs require established versioning strategies and rate-limiting recommendations. Defining these rules during endpoint design prevents breaking changes and controls traffic across public, private, and partner integrations.

Can I use these REST API design guidelines to review existing contracts?

You can use these REST API design guidelines to review existing contracts by validating URL naming, HTTP methods, status codes, and pagination. This enforces production-ready standards and solves inconsistencies when auditing existing services.