REST API Basics: Resources, Routes, and CRUD

GET /users

# Fetch a list of users.

POST /users

# Create a new user in the collection.

GET /users/{userId}

# Read one user by identifier.

PUT /users/{userId}

# Replace the full representation.

PATCH /users/{userId}

# Modify only selected fields.

DELETE /users/{userId}

# Remove one user.

GET /users/{userId}/orders

# Access a child collection under a parent resource.

GET /users/{userId}/settings

# Read a related settings object.

Prefer:  POST /invoices
Avoid:   POST /createInvoice

# Model the resource, not the action name.

Prefer:  /users
Avoid:   /user

# Keep collection naming consistent.

GET /users/123
GET /orders/ord_456

# Put stable IDs in the path.

POST /payments/{paymentId}/refunds

# Use an action subresource only for non-CRUD workflows.