httpANYrestresourcescollections
http
GET /usersCollections should usually be plural nouns. The server returns a list of resources, often with pagination metadata.
REST API Basics: Resources, Routes, and CRUD
Core REST API patterns for resource-oriented URLs, nested resources, and standard CRUD request examples.
Export
Copy the compact sheet, download it, or print it.
Download
`D` dense toggle · `C` copy all
Resource-oriented routes
Use nouns and predictable URL patterns for resources.
httpANYrestcreatepost
http
POST /usersPOST to a collection is the common create pattern. The server typically returns `201 Created` with the new representation or a location reference.
httpANYrestreadresource
http
GET /users/{userId}Single resources usually live at a stable item URL.
httpANYrestputidempotent
http
PUT /users/{userId}PUT is typically used when the client sends a full replacement representation and expects idempotent behavior.
httpANYrestpatchupdate
http
PATCH /users/{userId}PATCH is commonly used for partial updates so clients do not need to send the entire resource.
httpANYrestdeleteresource
http
DELETE /users/{userId}DELETE removes a resource or marks it deleted. Many APIs return `204 No Content` on success.
httpANYrestnestedrelationships
http
GET /users/{userId}/ordersNested routes are useful when the child is clearly scoped to the parent. Avoid deep nesting when it hurts discoverability.
httpANYrestsubresourcesettings
http
GET /users/{userId}/settingsA subresource can be appropriate when the related object has a stable identity within the parent.
Route shape examples
Preferred route patterns vs less RESTful shapes.
textANYrestnamingroutes
text
Prefer: POST /invoices
Avoid: POST /createInvoiceREST routes are usually clearer when they describe resources and let the HTTP method express the action.
textANYrestpluralcollections
text
Prefer: /users
Avoid: /userPlural nouns make it easier to distinguish collections from single-resource lookups.
textANYrestidspaths
text
GET /users/123
GET /orders/ord_456Stable identifiers make URLs shareable and cache-friendly. Avoid path values that change often.
textANYrestactionspayments
text
POST /payments/{paymentId}/refundsSome domain actions are best modeled as a resource creation under the target resource instead of a verb endpoint like `/refundPayment`.
More in REST API
REST API Best Practices and Anti-Patterns
High-signal design rules, consistency patterns, and common mistakes to avoid in production APIs.
REST API Request and Response Patterns
JSON request bodies, envelope choices, sparse fieldsets, includes, concurrency control, and common response contracts.
REST API Authentication, Authorization, and Versioning
Bearer auth, API keys, permission errors, versioning strategies, and compatibility patterns for HTTP APIs.
REST API Status Codes and Error Response Design
Practical HTTP status codes, error response bodies, validation failures, and troubleshooting-friendly API error contracts.
REST API Pagination, Filtering, Sorting, and Search
Common collection query patterns including offset pagination, cursor pagination, filtering, sorting, and search.
REST API Resource Naming and URL Design
Naming conventions for resources, relationships, nested endpoints, and clean URL design.