skills.rest
OzeroHAX
OzeroHAXCOMMUNITY
Explore all skills by this author →
GitHub

coder-system-design-api-design

Enforce HTTP API design rules for versioning, errors, pagination, and idempotency.

32|7|Updated Jan 28, 2026
Search Tags:#versioning#api design#rest#observability#http#backward compatibility
One-click install
npx skills add https://github.com/OzeroHAX/AssistAgents --skill coder-system-design-api-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: coder-system-design-api-design
Source: https://github.com/OzeroHAX/AssistAgents/tree/main/templates/skills/coder/system-design/api-design
Command: npx skills add https://github.com/OzeroHAX/AssistAgents --skill coder-system-design-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive set of rules and best practices for designing robust, backward-compatible, and observable HTTP APIs, ensuring a smooth developer experience and reliable system integrations.

Core Features & Use Cases

  • API Design Principles: Enforces consistent use of HTTP semantics, resource modeling, and versioning strategies.
  • Error Handling & Idempotency: Defines standards for machine-readable error formats and supports idempotency for mutating operations.
  • Use Case: When developing a new microservice, use this Skill to ensure its API adheres to established standards for versioning, error reporting, and client interactions, preventing future compatibility issues.

Quick Start

Use the coder-system-design-api-design skill to define the API contract for a new user management service.

Frequently Asked Questions about coder-system-design-api-design

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

FAQPage Schema
How do I design a REST API that maintains backward compatibility while evolving contracts?▼

Designing a backward-compatible REST API requires enforcing strict versioning strategies, consistent HTTP semantics, and resource modeling. This ensures stable contracts and reliable system integrations without breaking existing client interactions.

What is the best way to model machine-readable errors and support idempotency in HTTP APIs?▼

Modeling machine-readable errors and supporting idempotency involves defining standard error formats and implementing idempotency keys for mutating operations. This provides a smooth developer experience and prevents duplicate side effects in HTTP APIs.

How do I implement pagination and observability for a new microservice API?▼

Implementing pagination and observability for a microservice API requires adherence to established API design rules. This guarantees the HTTP API remains observable and handles resource pagination efficiently for reliable client interactions.

When do I need API versioning and compatibility policies for HTTP semantics?▼

You need API versioning and compatibility policies when evolving HTTP API contracts to prevent future integration issues. Enforcing these policies ensures resource modeling and HTTP semantics remain stable across new service versions.

Does this API design approach work for defining the contract of a new user management service?▼

Yes, this API design approach works for defining a new user management service contract by enforcing observability, error modeling, and idempotency standards. It prevents compatibility issues and ensures reliable client interactions.

Related Skills

Explore More Software Engineering Skills→
mpadmarajmpadmaraj
2

api-design

Define REST API contracts with endpoints, HTTP methods, schemas, and error handling.

Community
Basic
oimiragieooimiragieo
36

doc-generator

Generate API documentation, developer guides, and OpenAPI/Swagger specs from code.

Community
Advanced
KrishnatejavepaKrishnatejavepa
14

observability-and-instrumentation

Instrument code with logging, metrics, tracing, and alerting for production observability.

Community
Advanced
duylinhdang1998duylinhdang1998

graphql-expert

Design and implement type-safe GraphQL APIs with DataLoader batching and Relay pagination.

Community
Advanced