Named Resource and Actions API


This API example demonstrates how to name a resource and its actions, to give the reader a better idea about what the resource is used for.

API Blueprint

My Message

OK, My Message probably isn’t the best name for our resource but it will do for now. Note the URI /message is enclosed in square brackets.

Retrieve a Message

Now this is informative! No extra explanation needed here. This action clearly retrieves the message.

REQUEST

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        Hello World!

                      
                        
                      

Update a Message

Update a message - nice and simple naming is the best way to go.

REQUEST

Headers
Content-Type text/plain
text/plain
                          All your base are belong to us.

                        
                          
                        

RESPONSE

Headers