restlet和ajax,GitHub - restlet/restlet-framework-js: Restlet Framework for JavaScript

Restlet Framework

⚠️ Restlet Framework JS is not maintained ⚠️

You can use the Java version which is maintained instead.

RESTful web API framework for JavaScript

Version

Linux

OS X

Windows

Coverage

Dependencies

Do you want to blend your web services, web sites and web clients into unified web applications exposing and consuming RESTful web APIs?

Leverage the open source Restlet Framework and its unique JavaScript API available in two consistent editions: Node.js and Browser/AJAX!

NOTE: this is a port in progress of the Restlet Framework for Java.

Installing

For Node, use NPM with the following command:

npm install restlet

For browsers, use Bower with the following command:

bower install restlet

or get the JavaScript files from folder browser/dist from Github.

Getting started

Within Node applications

Restlet JS follows the same concepts than the Java version. It leverages the following elements:

Component that integrates the whole engine (server and application)

Server that makes available the Restlet applications for a specific protocol

Application that corresponds to the Restlet application itself and allows to define

processing elements for requests

Router that defines how can server resources will be accessed

Server resource corresponds to the element to process request

Following code describes how to implement a simple Restlet application using JavaScript

and Node:

var restlet = require('restlet');

var component = restlet.createComponent();

// Add a new HTTP server listening on port 3000.

component.addServer('http', 3000);

// Create the sample application.

var application = restlet.createApplication(function() {

// Create the application router

var router = restlet.createRouter();

// Attach a list element server resource

router.attach('/contacts/',

restlet.createServerResource().get(function(request, response) {

var contacts = [

{

id: '1',

lastName: 'Fielding',

firstName: 'Roy'

}

];

response.writeObject(contacts);

response.end();

})

.post({ convertInputEntity: true,

parameters: [ 'entity', 'response'] }, function(contact, response) {

// add contact

(...)

response.status('201');

response.end();

});

);

return router;

});

// Attach the sample application.

component.getDefaultHost().attachDefault(application);

// Start the component.

component.start();

Restlet JS also provides a client support to call REST resources:

var restlet = require('restlet');

restlet.createClientResource('http://myurl')

.get({

accept: 'application/json'

parameters: [ 'entity' ],

convertOutputEntity: true },

function(entity) {

(...)

});

Within browsers

Restlet JS also provides a client support to call REST resources with browsers:

$(document).ready(function() {

$('#test').click(function() {

restlet.createClientResource('http://localhost:8080/data.json').get({

accept: 'application/json',

parameters: [ 'entity' ],

convertInputEntity: true

}, function(entity) {

console.log('>> entity = ' + JSON.stringify(entity));

});

});

});

Run Restlet client

Samples applications

Discover simple sample applications in our repository:

Documentation

Version

Status

Documentation

Support

If you have questions about the framework and the way to use it, you can ask a question

on the StackOverflow website using tags restlet and javascript

or restlet.js.

Contribute

If you want to contribute to the framework, please have a look at this page:

Contributing to Restlet JS

Copyright

Copyright 2015 Restlet, Inc.