January 1, 2020

998 words 5 mins read

vasanthv/jsonbox

A Free HTTP based JSON storage.


repo name	vasanthv/jsonbox
repo link	https://github.com/vasanthv/jsonbox
homepage	https://jsonbox.io
language	JavaScript
size (curr.)	1929 kB
stars (curr.)	2068
created	2019-09-03
license	MIT License

jsonbox.io

A HTTP based JSON storage. It lets you store, read & modify JSON data over HTTP APIs for FREE. Ideal for small projects, prototypes or hackathons, where you don’t have to spin up your own data store.

With the new private boxes (introduced in v2), you can even power your websites with jsonbox.io.

API Documentation

Base URL: https://jsonbox.io/

Create

You can create a record (or add a record) to a box by using HTTP post to jsonbox.io/${BOX_ID}.

curl -X POST 'https://jsonbox.io/demobox_6d9e326c183fde7b' \
    -H 'content-type: application/json' \
    -d '{"name": "Jon Snow", "age": 25}'

Response:

{
	"_id": "5d776a25fd6d3d6cb1d45c51",
	"name": "Jon Snow",
	"age": 25,
	"_createdOn": "2019-09-10T09:17:25.607Z"
}

You can also create multiple records at once by passing an array

curl -X POST 'https://jsonbox.io/demobox_6d9e326c183fde7b' \
    -H 'content-type: application/json' \
    -d '[{"name": "Daenerys Targaryen", "age": 25}, {"name": "Arya Stark", "age": 16}]'

[
	{
		"_id": "5d776b75fd6d3d6cb1d45c52",
		"name": "Daenerys Targaryen",
		"age": 25,
		"_createdOn": "2019-09-10T09:23:01.105Z"
	},
	{
		"_id": "5d776b75fd6d3d6cb1d45c53",
		"name": "Arya Stark",
		"age": 16,
		"_createdOn": "2019-09-10T09:23:01.105Z"
	}
]

You can also pass in an optional collections parameter in the URL to group records jsonbox.io/${BOX_ID}/${COLLECTION}.

Note: A valid ${BOX_ID} & ${COLLECTION} should contain only alphanumeric characters & _. ${BOX_ID} should be at least 20 characters long.

Read

Use HTTP GET to read all the records or a single record. You can also query & sort the records.

curl -X GET 'https://jsonbox.io/demobox_6d9e326c183fde7b'

[
	{
		"_id": "5d776b75fd6d3d6cb1d45c52",
		"name": "Daenerys Targaryen",
		"age": 25,
		"_createdOn": "2019-09-10T09:23:01.105Z"
	},
	{
		"_id": "5d776b75fd6d3d6cb1d45c53",
		"name": "Arya Stark",
		"age": 16,
		"_createdOn": "2019-09-10T09:23:01.105Z"
	},
	{
		"_id": "5d776a25fd6d3d6cb1d45c51",
		"name": "Jon Snow",
		"age": 25,
		"_createdOn": "2019-09-10T09:17:25.607Z"
	}
]

To get all records inside a collection Sample collection name: “users”:

curl -X GET 'https://jsonbox.io/demobox_6d9e326c183fde7b/users'

To sort the records by a specific field use sort query param. In the below example the output will be sorted in the descending order of the age.

curl -X GET 'https://jsonbox.io/demobox_6d9e326c183fde7b?sort=-age'

To read a specific record use jsonbox.io/${BOX_ID}/${RECORD_ID}.

curl -X GET 'https://jsonbox.io/demobox_6d9e326c183fde7b/5d776a25fd6d3d6cb1d45c51'

To query records, you have to pass the key & value as shown below.

curl -X GET 'https://jsonbox.io/demobox_6d9e326c183fde7b?q=name:arya%20stark'

All the accepted query params are as follows.

Param	Description	Default
sort	Used to sort the result set by the specific field. Add a prefix “-” to sort in reverse order.	-_createdOn
skip	Used to skip certain no. of fields. Can be used for pagination.	0
limit	Used to limit the results to a specific count. Can be used for pagination. Max. is 1000.	20
q	Query for filtering values. Check out the format below.

Filtering

You can pass a filter in a query by passing them in URL param q as shown below:

curl -X GET 'https://jsonbox.io/demobox_6d9e326c183fde7b?q=name:arya%20stark,age:>13'

The above sample will look for the name arya stark and age greater than 13. You can filter on Number, String & Boolean values only.

Different filters for Numeric values.

	Sample
To filter values greater than or less than a specific value	`q=age:>10` or `q=age:<10`
To filter values greater (or less) than or equal to a specific value	`q=age:>=10` or `q=age:<=10`
To filter values that match a specific value.	`q=age:=10`

Different filters for String values.

	Sample
Filter values that start with a specific string	`q=name:arya*`
Filter values that end with a specific string	`q=name:*stark`
Filter values where a specific string appears anywhere in a string	`q=name:ya`
Filter values that match a specific string	`q=name:arya%20stark`

You can combine multiple fields by separating them with commas as shown below:

https://jsonbox.io/demobox_6d9e326c183fde7b?q=name:arya%20stark,age:>13,isalive:true

Update

Use HTTP PUT to update record one by one. Please note that this will not patch the record, it is full update. A Bulk update is not supported yet.

curl -X PUT 'https://jsonbox.io/demobox_6d9e326c183fde7b/5d776b75fd6d3d6cb1d45c53' \
    -H 'content-type: application/json' \
    -d '{"name": "Arya Stark", "age": 18}'

Delete

Two approaches are available for delete

To delete a specific record use HTTP DELETE with jsonbox.io/${BOX_ID}/${RECORD_ID}

curl -X DELETE 'https://jsonbox.io/demobox_6d9e326c183fde7b/5d776b75fd6d3d6cb1d45c53'

To delete based on a filter use HTTP DELETE with jsonbox.io/${BOX_ID}?q={QUERY}

curl -X DELETE 'https://jsonbox.io/demobox_6d9e326c183fde7b?q=name:arya%20stark,age:>13'

Private Box

A private box is similar to a regular box, but you need an API-KEY to create / update / delete records. Reading records is open and does not need API-KEY. Pass the API-KEY using the X-API-KEY HTTP header.

curl -X POST 'https://jsonbox.io/demobox_6d9e326c183fde7b' \
    -H 'content-type: application/json' \
	--H 'x-api-key: 7b3b910b-a7ad-41e8-89d6-5e28e2e34e70' \
    -d '{"name": "Jon Snow", "age": 25}'

You can also use Authorization: API-KEY 7b3b910b-a7ad-41e8-89d6-5e28e2e34e70 header. An API-KEY should be a valid GUID/UUID.

How to create a private box?

You create a private box by pushing your first record to a new box with an API-KEY. All the subsequent write requests to that box expect the API-KEY to be passed. You cannot change a public box to private or vice versa.

Limitations

Added some limitations to avoid abuse.

The request body cannot be more than 10KB.
Can’t push or pull more than 1000 records at a time.
There is no limit on the number of records you store in a box, but please don’t abuse the API by storing large datasets of more than 5000 records. This is meant for small projects and that’s why it is offered FREE of cost.

Wrappers

Note: The wrappers listed here are from other sources and it is not been tested on validated by us

Go: peteretelej/jsonbox (Github)
Java:
1. https://search.maven.org/artifact/io.jsonbox/jsonbox (Github)
2. https://github.com/leeu1911/jsonbox-java
Node: https://www.npmjs.com/package/jsonbox-node (Github)
Python: https://pypi.org/project/jsonbox/ (Github)
React: https://www.npmjs.com/package/react-jsonbox (Github)
Rust: https://crates.io/crates/jsonbox (Github)

How to run locally

Fork this repo and then clone it:

git clone https://github.com/<your_name>/jsonbox.git

You need MongoDB to run this application. If you don’t already have MongoDB, go to the official documentation and follow the instructions there. Once you have MongoDB installed, run

mongo

to start the MongoDB instance. Then cd into directory where the repo was cloned and install the dependencies:

npm install

Then just run

npm start

to start the development server on port 3000. Your jsonbox instance will be running on http://localhost:3000. Alternatively you can run the application usng docker with docker-compose up.