| 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.
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.
Restlet JS follows the same concepts than the Java version. It leverages the following elements:
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) {
(...)
});
Restlet JS also provides a client support to call REST resources with browsers:
<html>
<head>
<script type="text/javascript" src="jquery-2.1.4.min.js"></script>
<script type="text/javascript" src="lodash.min.js"></script>
<script type="text/javascript" src="moment-2.10.3.js"></script>
<script type="text/javascript" src="restlet.min.js"></script>
<script type="text/javascript">
$(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));
});
});
});
</script>
</head>
<body>
<span id="test">Run Restlet client</span>
</body>
</html>
| Version | Status | Documentation |
|---|---|---|
| 0.4.1 | In progress | Server API Reference |
| 0.4.1 | In progress | Client API Reference |
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.
If you want to contribute to the framework, please have a look at this page: Contributing Restlet JS
Copyright 2015 Restlet, Inc.
FAQs
RESTful web API framework for JavaScript
The npm package restlet receives a total of 4 weekly downloads. As such, restlet popularity was classified as not popular.
We found that restlet demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenAI rotated macOS signing certificates after a malicious Axios package reached its CI pipeline in a broader software supply chain attack.
Security News
Open source is under attack because of how much value it creates. It has been the foundation of every major software innovation for the last three decades. This is not the time to walk away from it.
Security News
Socket CEO Feross Aboukhadijeh breaks down how North Korea hijacked Axios and what it means for the future of software supply chain security.