3. Named Resource and Actions.md

FORMAT: 1A

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

• Previous: Resource and Actions
• This: Raw API Blueprint
• Next: Grouping Resources

My Message [/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 [GET]

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

• Response 200 (text/plain)

    Hello World!
  

Update a Message [PUT]

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

• Request (text/plain)

    All your base are belong to us.
  

• Response 204