Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.63 KB

2. Resource and Actions.md

File metadata and controls

32 lines (20 loc) · 1.63 KB

FORMAT: 1A

Resource and Actions API

This API example demonstrates how to define a resource with multiple actions.

API Blueprint

/message

This is our resource. It is defined by its URI or, more precisely, by its URI Template.

This resource has no actions specified but we will fix that soon.

GET

Here we define an action using the GET HTTP request method for our resource /message.

As with every good action it should return a response. A response always bears a status code. Code 200 is great as it means all is green. Responding with some data can be a great idea as well so let's add a plain text message to our response.

  • Response 200 (text/plain)

      Hello World!

PUT

OK, let's add another action. This time to put new data to our resource (essentially an update action). We will need to send something in a request and then send a response back confirming the posting was a success (HTTP Status Code 204 ~ Resource updated successfully, no content is returned).

  • Request (text/plain)

      All your base are belong to us.

  • Response 204