RESTful API

RESTful service URLs

• GET http://localhost/users — get all users.
• GET http://localhost/users/{id} — get user with the given id.
• POST http://localhost/users — create user.
• PUT http://localhost/users/{id} — update(replace) user with given id.
• DELETE http://localhost/users/{id} — delete user with given id.
• OPTIONS http://localhost/users[/{id}] — get allowed options (HTTP methods) of the resource.
• HEAD http://localhost/users[/{id}] — get meta data (created, updated, revision, etc.) of the resource.

Options Response

HTTP/1.1 200 OK
Allow: GET,HEAD,POST,OPTIONS,TRACE
Content-Type: text/html; charset=UTF-8
Date: Sat, 23 October 2021 10:24:43 GMT
Content-Length: 0

Head Response

HTTP/1.1 200 OK
Accept-Ranges: bytes
Content-Type: text/html; charset=UTF-8
Date: Fri, 01 October 2021 11:21:13 GMT
Last-Modified: Sat, 23 October 2021 10:24:43 GMT
Content-Length: 1270

Reference

• What is a REST API? — RedHat
• Method Definitions — HTTP/1.1
• API Design Best Practices