jquery-nor-rest
v0.3.7
Published
jQuery REST client plugin for Sendanor REST APIs
Downloads
8
Readme
jquery-nor-rest
jQuery REST client plugin for Sendanor REST APIs
Usage
First make sure you include our jQuery plugin file jquery.nor.rest.js
.
Fetching data with GET requests
When /api
returns:
{
"$ref": "http://zeta3-lts-local:3000/api",
"profile": {
"$ref": "http://zeta3-lts-local:3000/api/profile",
"username": "foo"
}
}
...and /api/profile
returns:
{
"$ref": "http://zeta3-lts-local:3000/api/profile",
"username": "foo",
"email": "[email protected]"
}
Then you can call $.nor.rest.get(url[, params])
like this:
$.nor.rest.get('/api').done(function(api) {
if(api.profile) {
// Any partial data that's available can be used here
console.log( api.profile.username );
// Get full user resource. Calling `api.profile()` is same as calling
// `$.nor.rest.get('/api/profile')`.
api.profile().done(function(profile) {
console.log( profile );
});
}
});
Changing the data with POST request
In this example the POST handler redirects the user back to /api/profile
:
$.nor.rest.get('/api').done(function(api) {
if(api.profile) {
// Get full user resource. Calling `api.profile.post()` is same as calling
// `$.nor.rest.post('/api/profile')`.
api.profile.post({'foo':'bar'}).done(function(profile) {
console.log( profile );
});
}
});