Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

REST: what's the name for the HTTP verb and endpoint?

Given this:

GET /users

/users is called endpoint in REST terminology.

How do you call the whole GET /users (verb + endpoint) instead? I hope there is one word for it.

Thanks.

like image 306
Dan Avatar asked Sep 03 '13 09:09

Dan


2 Answers

You probably won't like this answer, but here it is anyway: REST does not use the terminology "endpoint" at all. You can check Fielding's thesis yourself: http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm - open the PDF and search for "endpoint".

Fumanchu's answer is probably the closest you get: "/Users" is a relative path and can be used as the Request-URI in the Request-Line as per the 2616 HTTP spec.

In a web API documentation I would probably call "/Users" an "Endpoint" reference as you do, and "GET /Users" would be an "Operation". Maybe you can get some inspiration here: https://nhs.3scale.net/docs

like image 134
Jørn Wildt Avatar answered Oct 30 '22 10:10

Jørn Wildt


The API Bluprint Language Specification refers to the HTTP method, when applied to a resource, as a resource action. This name seems to be consistent with the terminology in section 5.2.1.2 Representations, of Fielding's dissertation.

like image 30
Christian Trimble Avatar answered Oct 30 '22 12:10

Christian Trimble