a json-api compliant rest library
JavaScript
Pull request Compare This branch is 389 commits behind endpoints:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
modules
test
.gitignore
.jscsrc
.jshintrc
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

endpoints Build Status

A json-api compliant framework for javascript.

NPM

What is it?

A json-api compliant framework for javascript that works with Bookshelf and any http server that supports express or hapi style request handlers.

Check out the example implementation.

Endpoints.Application

A container for your API. All resources are registered with it, and all route handlers for your API should be created using it. This is mainly for making it possible to generate self-documentation. Something in the Endpoints stack needs to be aware of every resource/route created in the API. Further down the road, this could be used to do all sorts of magical convention-based stuff like creating admin interfaces, interactive API documentation, etc.

For a more comprehensive explanation, see the README.

Endpoints.Source

This is a thin wrapper for any ORM. Typically you will never interact with a Source directly. It presents a standardized, callback-based API that can communicate with Endpoints.Controller. There is currently only one implementation: Endpoints.BookshelfSource.

For a more comprehensive explanation, see the README.

Endpoints.Controller

This provides methods for generating CRUD request handling functions. Each controller is associated with a single Source instance. The API is very simple, providing create, read, update, & destroy methods, each of which can be configured with an options object.

For a more comprehensive explanation, see the README.