What is a RESTful word for "Operation"

128 views
Skip to first unread message

Rahul Singh

unread,
Dec 25, 2012, 5:32:37 PM12/25/12
to api-...@googlegroups.com
Hi,

In the SOAP/WSDL days, the word Operation was used to mean a method (in the RPC sense if you will) on a web service. So GetAddress, AddAddress and ListAddresses were all "Operations" on the Address WebService. 

In the REST paradigm, we have HTTP Method and Routes like:

  GET /address/:id
  PUT /address/:id

However I have a requirement that I want to refer to this combination of HTTPMethod and Path and call it something so I can talk about it in documentation and UI elements etc. (eg: metrics for the GET address operation)

I don't want to call them operations, for fear of getting beaten up because that's not very RESTful. What is the preferred name for such things in the REST world? 

Rahul


Pete Johanson

unread,
Dec 25, 2012, 5:37:24 PM12/25/12
to api-...@googlegroups.com

I would normally use the some what generic request/response terms.

-pete

--
You received this message because you are subscribed to the Google Groups "API Craft" group.
To unsubscribe from this group, send email to api-craft+...@googlegroups.com.
Visit this group at http://groups.google.com/group/api-craft?hl=en.
 
 

Steve Klabnik

unread,
Dec 25, 2012, 5:53:17 PM12/25/12
to api-...@googlegroups.com
REST is not RPC, so framing them as a method name is not appropriate.

I would say "a GET on the address resource".

mca

unread,
Dec 25, 2012, 7:53:04 PM12/25/12
to api-...@googlegroups.com

I usually use the word "interaction"

Mike Amundsen

On Dec 25, 2012 5:32 PM, "Rahul Singh" <rsi...@distelli.com> wrote:

Brian Mulloy

unread,
Dec 25, 2012, 9:02:13 PM12/25/12
to api-...@googlegroups.com
While prototyping I prefer "incantation"

Sent from my iPhone

Glenn Block

unread,
Dec 25, 2012, 9:37:30 PM12/25/12
to api-...@googlegroups.com
+1


On Tue, Dec 25, 2012 at 2:53 PM, Steve Klabnik <st...@steveklabnik.com> wrote:
REST is not RPC, so framing them as a method name is not appropriate.

I would say "a GET on the address resource".

Dietrich Schulten

unread,
Dec 27, 2012, 2:15:59 AM12/27/12
to api-...@googlegroups.com

'The metrics of the GET address method' reads fine for me. Why not use the word 'method' in the context of a Rest api documentation? One can also leave it out,  as in 'use POST address to add more addresses'.
Dietrich

Reply all
Reply to author
Forward
0 new messages