---

name: api-design-guidelines description: REST API design guidelines

API Design Guidelines

REST Principles

• Use nouns for resources
• Use HTTP methods correctly
• Return appropriate status codes

URL Structure

CopyGET    /users          # List
GET    /users/{id}     # Get one
POST   /users          # Create
PUT    /users/{id}     # Update
DELETE /users/{id}     # Delete

Status Codes

Response Format

Copy{
  "data": { },
  "meta": { "page": 1 },
  "errors": [ ]
}

Versioning

• URL: /v1/users
• Header: Accept-Version

Documentation

• Use OpenAPI/Swagger
• Document all endpoints
• Include examples