REST API Design Principles

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Resource Naming

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.

Use Nouns

GET /users
GET /users/123
POST /users

Avoid Verbs

# Bad
GET /getUsers
POST /createUser

# Good
GET /users
POST /users

HTTP Methods

Duis aute irure dolor in reprehenderit.

Method	Purpose
GET	Read
POST	Create
PUT	Replace
PATCH	Update
DELETE	Remove

Status Codes

Excepteur sint occaecat cupidatat non proident.

Success Codes

• 200 OK
• 201 Created
• 204 No Content

Error Codes

• 400 Bad Request
• 401 Unauthorized
• 404 Not Found
• 500 Server Error

Versioning

Lorem ipsum dolor sit amet.

URL Versioning

/api/v1/users
/api/v2/users

Header Versioning

Accept: application/vnd.api+json;version=1

Pagination

Sed do eiusmod tempor incididunt.

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100
  }
}

Conclusion

Good API design improves developer experience.