sarbull / rest-conventions

rest-conventions

Retrieve all

GET /api/elements

Request

GET /api/elements HTTP/1.1

Response

[
  {
    "id": 1,
    "name": "Oxygen",
    "atomicNumber": 8
  },
  {
    "id": 2,
    "name": "Carbon",
    "atomicNumber": 6
  }
]

Create

POST /api/elements

Request

{
  "name": "HELIUM",
  "atomicNumber": 2
}

Response

{
  "id": 3,
  "name": "HELIUM",
  "atomicNumber": 2
}

Retrieve one

GET /api/elements/:id

Request

GET /api/elements/3 HTTP/1.1

Response

{
  "id": 3,
  "name": "HELIUM",
  "atomicNumber": 2
}

Update one attribute

PATCH /api/elements/:id

Request

{
  "atomicNumber": 20
}

Response

{
  "id": 3,
  "name": "HELIUM",
  "atomicNumber": 20
}

Update entire entity

PUT /api/elements/:id

Request

{
  "name": "Helium",
  "atomicNumber": 2
}

Response

{
  "id": 3,
  "name": "Helium",
  "atomicNumber": 2
}

Delete

DELETE /api/elements/:id

Request

DELETE /api/elements/3 HTTP/1.1

Response

HTTP/1.1 204 NO CONTENT

Custom actions

POST /api/elements/:id/actions

Request

{
  "type": "RAISE_CONCENTRATION",
  "payload": {
    "percentage": 20
  }
}

Response

HTTP/1.1 200 OK