skills.rest
cyphercr0w
cyphercr0wCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Define REST API conventions for resource naming, HTTP methods, and response formats.

8|Updated Feb 15, 2026
Search Tags:#architecture#api design#rest#backend development#web services#api patterns
One-click install
npx skills add https://github.com/cyphercr0w/codeck --skill api-design-cyphercr0w
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/cyphercr0w/codeck/tree/main/apps/runtime/src/templates/presets/default/ecc/skills/api-design
Command: npx skills add https://github.com/cyphercr0w/codeck --skill api-design-cyphercr0w

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides comprehensive guidelines and best practices for designing consistent, developer-friendly, and production-ready REST APIs, addressing common challenges in API development.

Core Features & Use Cases

  • Resource Design: Establishes conventions for URL structures, naming, and HTTP methods.
  • Status Codes & Responses: Details semantic use of HTTP status codes and standardized JSON response formats for success, collections, and errors.
  • Pagination, Filtering, Sorting: Offers strategies for efficient data retrieval and manipulation.
  • Authentication, Authorization, Rate Limiting: Outlines secure and manageable API access patterns.
  • Versioning: Provides a clear strategy for evolving APIs without breaking existing clients.
  • Use Case: When designing a new microservice API, use this Skill to ensure all endpoints follow consistent patterns for resource naming, error handling, and pagination, making the API intuitive for consumers.

Quick Start

Use the api-design skill to generate a REST API design for a user management system.

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 resource naming and URL structure?▼

Designing a REST API with consistent resource naming requires establishing clear conventions for URL structures, HTTP methods, and JSON response formats. This ensures your web services remain intuitive, scalable, and maintainable for consumers.

What is the best way to handle pagination and filtering in REST APIs?▼

Handling pagination and filtering in REST APIs requires implementing specific URL parameters and standardized response formats for efficient data retrieval. This prevents large payload issues and optimizes backend data manipulation.

How does API versioning work for evolving web services without breaking clients?▼

API versioning for evolving web services involves defining a clear versioning strategy within your URL structure or headers. This allows you to introduce new features and modify resources without breaking existing client integrations.

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

For REST API error responses, use standardized HTTP status codes that detail semantic use, paired with a consistent JSON response format. This clearly communicates success, collection states, and specific error conditions to API consumers.

Can I use this approach for microservice API authentication and rate limiting?▼

Yes, this approach outlines secure API access patterns for microservices, including authentication, authorization, and rate limiting. It facilitates the creation of manageable and secure REST APIs across distributed backend services.

Related Skills

Explore More Software Engineering Skills→
eng-vmessiaheng-vmessiah
2

api-design

Standardizes REST API architecture including naming conventions, HTTP semantics, and error formats.

Community
Advanced
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
cenjiecenjie

api-error-handling

Implements error handling for REST and GraphQL endpoints with retries and circuit breaking.

Community
Advanced
iludeilude
8

api-design-patterns

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

Community
Advanced