jsonite
v0.0.2
Published
A server for prototyping jsonapi compliant apis backed by leveldb
Downloads
2
Maintainers
Readme
jsonite
This is an API server designed for prototyping new jsonapi compliant apis.
Powered By
- levelup - persistence to leveldb.
- joi - model schemas and validation
- beeline - lightweight URL routing
Example Usage
var http = require('http');
var jsonite = require('jsonite');
var api = jsonite();
var server = http.createServer(api.router);
api.provide('author', {
name: api.types.string().required(),
books: api.ref('*book')
});
api.provide('book', {
title: api.types.string().required(),
authors: api.ref('*author')
});
server.listen(3000);
Prior Art
The following are other systems that provide similar functionality to jsonite:
References
jsonite(opts) => API
Create a new API
object that we are able to initialize.
API#provide(name, schema)
Register a new model in the API.
License(s)
MIT
Copyright (c) 2014 Damon Oehlman [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.