Back

REST API design

REST APIs use URLs for resources (nouns) and HTTP methods for actions (verbs). Use plural nouns, and return the right status codes. GET reads, POST creates, PUT/PATCH updates, DELETE removes.

GET    /api/users       -> list users       200
GET    /api/users/42    -> one user         200 / 404
POST   /api/users       -> create user      201
PATCH  /api/users/42    -> update user      200
DELETE /api/users/42    -> delete user      204

// Bad:  POST /api/createUser
// Good: POST /api/users

app.get("/api/users", listUsers)
app.post("/api/users", createUser)
app.delete("/api/users/:id", deleteUser)

Roadmap