rest-api-design

RESTful API design guidance covering resource modeling, HTTP methods, status codes, versioning, and documentation. Design REST APIs that are intuitive, consistent, and follow industry best practices for resource-oriented architecture. Minimal working example: Detailed implementations in the references/ directory: - Covers resource naming conventions, HTTP method usage, query parameters, response formats, and status code selection with clear do's and don'ts - Includes reference guides for OpenAPI documentation, request/response examples, API versioning, authentication, rate limiting, and a complete Express.js implementation example - Emphasizes consistency through plural resource names, appropriate status codes, pagination, filtering, and ISO 8601 date formatting - Provides best practices for security (HTTPS, authentication), backward compatibility, error messaging, and avoiding common pitfalls like verb-based endpoints and over-nested resources - Overview - When to Use - Quick Start - Reference Guides - Best Practices - Designing new RESTful APIs - Creating endpoint structures - Defining request/response formats - Implementing API versioning - Documenting API specifications - Refactoring existing APIs - Use nouns for resources, not verbs - Use plural names for collections - Be consistent with naming conventions - Return appropriate HTTP status codes - Include pagination for...