REST API Design

Use when designing a REST/HTTP API surface and its contract — choosing resources and URLs, picking HTTP methods and status codes, defining the error model (RFC 9457 problem+json), shaping the success/pagination envelope, versioning, auth, and rate limiting, then expressing the design as an OpenAPI 3.1 contract. This is the design discipline that sits ABOVE a web framework: it produces the decisions and the contract, not the handler code. Keywords: REST API design, HTTP API, resource modeling, status codes, problem details, RFC 9457, pagination, API versioning, rate limiting, OpenAPI 3.1 contract.

bm629 Updated 7 repo stars

File contents

bm629/agent-skills commit c4aebf8ec5 Runs: bm629/pydantic-v2

Frequently asked questions

npx get-skill add bm629/rest-api-design