api-rest-design

What problem does it solve?

This Skill provides structured guidance to design intuitive, versioned RESTful APIs, reducing inconsistent endpoints and brittle integrations.

Core Features & Use Cases

• Resource-based design: guidelines on selecting nouns for endpoints and applying proper HTTP methods.
• Versioning and lifecycle: strategies for path and header versioning, deprecation, and migration planning.
• Error handling and responses: standard error formats, pagination, and consistent success responses.
• Use Case: design endpoints for a store with products, users, and orders such as /v1/products and /v2/orders, with clear field schemas and examples.

Quick Start

Create a versioned API outline for a small service: define resources, URIs, sample requests, and an OpenAPI skeleton.