skills.rest
Clean1ines
Clean1inesCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Standardize REST API design with resource naming, HTTP methods, and versioning guidelines.

Updated Mar 16, 2026
Search Tags:#versioning#rest#http#error-handling#rate-limiting#pagination#api-design
One-click install
npx skills add https://github.com/Clean1ines/crm_bot --skill api-design-clean1ines
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Clean1ines/crm_bot/tree/main/.agents/skills/ecc/api-design
Command: npx skills add https://github.com/Clean1ines/crm_bot --skill api-design-clean1ines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design often suffers from inconsistent naming, unclear status handling, and hard-to-maintain contracts across teams, leading to integration errors and slower product delivery.

Core Features & Use Cases

  • API Design Guidelines: resource naming, naming rules, and consistency across endpoints.
  • HTTP Semantics and Versioning: method semantics, status codes, and versioning strategy.
  • Pagination, Filtering, and Errors: patterns for pagination, query filtering, and robust error responses.
  • Real-world Use Case: designing a new public API for a partner; refining internal contracts for better maintainability.

Quick Start

Draft a concise REST API design for a new endpoint following resource naming, HTTP methods, pagination, and versioning guidelines.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I standardize REST API resource naming and HTTP methods across my team?▼

Design robust REST API pagination and filtering by applying standardized query patterns for large datasets, ensuring efficient data retrieval. Enforce consistent pagination strategies and query filtering guidelines to reduce payload size and optimize endpoint responses.

What is the best way to handle REST API versioning and error responses?▼

Handle REST API versioning and error responses by implementing safe versioning strategies and structured error handling formats. Establish clear versioning rules and robust error response patterns to prevent breaking changes and simplify client-side debugging.

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

Design robust REST API pagination and filtering by applying standardized query patterns for large datasets, ensuring efficient data retrieval. Enforce consistent pagination strategies and query filtering guidelines to reduce payload size and optimize endpoint responses.

Can I use standard REST API design guidelines for internal contracts and public partner APIs?▼

Use standard REST API design guidelines for both internal contract refinement and public partner API creation to ensure consistency. These guidelines apply to resource naming, authentication patterns, and status codes, maintaining clarity whether building new endpoints or refining existing contracts.

Why does inconsistent REST API design cause integration errors and slower product delivery?▼

Inconsistent REST API design causes integration errors and slower delivery due to unclear status handling, inconsistent naming, and hard-to-maintain contracts. Standardizing endpoint design, HTTP semantics, and error handling reduces confusion and accelerates product integration.

Related Skills

Explore More Software Engineering Skills→
JNZader-VaultJNZader-Vault

zod-validation

Validate TypeScript data structures at runtime using Zod schemas.

Official
Intermediate
curiositechcuriositech
181

openapi-spec-writer

Generate OpenAPI 3.0/3.1 YAML or JSON specifications for REST APIs.

Official
Advanced
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
Camilo8902Camilo8902

rest-to-graphql-migrator

Migrate REST APIs to GraphQL incrementally using schema stitching and REST data source wrappers.

Community
Advanced