Skip to content
This repository was archived by the owner on Dec 6, 2017. It is now read-only.

Latest commit

 

History

History
88 lines (62 loc) · 2.41 KB

RESTGuide.md

File metadata and controls

88 lines (62 loc) · 2.41 KB

REST Guide

apitrary uses RESTful APIs as backend for your applications. This guide will give you an detailled introduction to the API endpoints you will need to contact in order to store and retrieve information.

Base URL

apitrary will generate backends for your applications in very easy steps. A backend consists of a generated REST API with a set of REST endpoints. All endpoints will use following base URL:

https://YOUR_API_ID.api.apitrary.com/

Endpoints

Following will give you a brief overview of the provided endpoints:

Endpoint Verbs Comment
/:entity_name/:object_id GET Retrieve single object
/:entity_name POST Store a single object
/:entity_name/:object_id PUT Update single object
/:entity_name/:object_id DELETE Delete single object
/:entity_name/:object_id GET Retrieve single object
/:entity_name?q=:search_expression GET Search for objects

HTTP Verbs

apitrary is using

GET: Retrieving a single object

Talk about how to retrieve single objects from our data store.

Show JSON example with curl

POST: Storing a single object

Talk about how to store an object.

Show JSON example with curl

PUT: Updating an existing object

Talk about how to store an object.

Show JSON example with curl

DELETE: Delete an existing object

Talk about how to store an object.

Show JSON example with curl

Talk about the READ-/WRITE-Quorum of Riak and that developers might need to wait a bit before re-retrieving data from the data store.

Search

Show a simple example on how to search for a field and a given value in this field. Tell the user to look into our extensive search guide (also only examples from Riak Solr).

Also tell the developer/reader to look into Solr search.