Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

What is REST API?

A RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data.

...

A RESTful API breaks down a transaction to create a series of small modules. Each module addresses a particular underlying part of the transaction. This modularity provides developers with a lot of flexibility. 

How to set up Burti REST API?

Initial setup is rather complicated, so we do it for the costumer. However, there are some prerequisites that needs to be done, in order to set it up:

...

Code Block
curl "http://localhost:1402/Web_JSON_Composer.hal" -d @sample.get.data.txt > response.get1.json
curl "http://localhost:1402/Web_JSON_Composer.hal" -d @sample.get.data2.txt > response.get2.json
curl "http://localhost:1402/Web_JSON_UpdatingComposer.hal" -d @sample.post.data.txt > response.post.json

OR

Custom built scripts/applications which can execute curl request commands.


The requests are as follows:

...

Response file  response.get2.json

Insert a new item

sample.post.json - made to the WRITE interface Web_JSON_UpdatingComposer.hal:

...