be-api-design

What problem does it solve?

This Skill helps teams lock REST API contracts early to prevent drift between design and implementation, ensuring consistency across services.

Core Features & Use Cases

• Resource-first REST patterns and explicit endpoint boundaries (collection, single resource, nested resources)
• OpenAPI 3.1 as the single source of truth for models, endpoints, request/response schemas, and error catalog
• Consistent naming, response envelopes, and pagination/filtering strategies to reduce contract drift
• Use Case: Design a new partner API with versioning, error contracts, and rate-limiting rules

Quick Start

Define the API resource model and endpoint table, then fix the OpenAPI 3.1 starter contract.