api-design

From README

API Design Patterns Conventions and best practices for designing consistent, developer-friendly REST APIs. When to Activate Designing new API endpoints Reviewing existing API contracts Adding pagination, filtering, or sorting Implementing error handling for APIs Planning API versioning strategy Building public or partner-facing APIs Resource Design URL Structure Naming Rules HTTP Methods and Status Codes Method Semantics | Method | Idempotent | Safe | Use For | |--------|-----------|------|---------| | GET | Yes | Yes | Retrieve resources | | POST | No | No | Create resources, trigger actions | | PUT | Yes | No | Full replacement of a resource | | PATCH | No | No | Partial update of a resource | | DELETE | Yes | No | Remove a resource | PATCH can be made idempotent with proper implementation Status Code Reference Common Mistakes Response Format Success Response Collection Response (with Pagination) Error Response Response Envelope Variants Pagination Offset-Based (Simple) Pros: Easy...