sails-restful
v0.1.5
Published
A restful api adapter for Sails / Waterline
Downloads
2
Maintainers
Readme
sails-restful
Provides easy access to restful api
from Sails.js & Waterline.
This module is a Sails/Waterline community adapter. Its goal is to provide a set of declarative interfaces, conventions, and best-practices for integrating with the rest database/service.
Strict adherence to an adapter specification enables the (re)use of built-in generic test suites, standardized documentation, reasonable expectations around the API for your users, and overall, a more pleasant development experience for everyone.
Installation
To install this adapter, run:
$ npm install sails-restful
Then connect the adapter to one or more of your app's datastores.
Usage
Visit Models & ORM in the docs for more information about using models, datastores, and adapters in your app/microservice.
Questions?
See Extending Sails > Adapters > Custom Adapters in the Sails documentation, or check out recommended support options.
Compatibility
This adapter implements the following methods:
| Method | Status | Category | |:---------------------|:------------------|:--------------| | registerDatastore | in progress | LIFECYCLE | | teardown | in progress | LIFECYCLE | | create | Planned | DML | | createEach | Planned | DML | | update | Planned | DML | | destroy | Planned | DML | | find | in progress | DQL | | join | ??? | DQL | | count | Planned | DQL | | sum | Planned | DQL | | avg | Planned | DQL | | define | Planned | DDL | | drop | Planned | DDL | | setSequence | ??? | DDL |
License
This rest adapter is available under the MIT license.
As for Waterline and the Sails framework? They're free and open-source under the MIT License.