curl 'http://localhost:3000/todos/' -H 'Content-Type: application/json' --data-binary '{ "text": "You have to do dishes!" }'A Feathers SocketIO example
- - - - - - -``` - -After restarting, going directly to [localhost:3000](http://localhost:3000) with the console open will show what is happening on the HTML page. You can also see the newly created Todo at the REST endpoint [localhost:3000/todos](http://localhost:3000/todos). With the page open, creating a new Todo via the REST API, for example - -curl 'http://localhost:3000/todos/' -H 'Content-Type: application/json' --data-binary '{ "text": "Do something" }'curl 'http://localhost:3000/users/' -H 'Content-Type: application/json' --data-binary '{ "username": "feathers", "password": "supersecret" }'
+ 
+
[](https://gitter.im/feathersjs/feathers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-> Shared REST and real-time APIs with Express.
+[](https://travis-ci.org/feathersjs/feathers)
-## To get started
+Feathers is a real-time, micro-service web framework for NodeJS that gives you control over your data via RESTful resources, sockets and flexible plug-ins.
-Feathers extends [Express 4](http://expressjs.com), one of the most popular web frameworks for [NodeJS](http://nodejs.org/). It makes it easy to create shared RESTful web services and real-time applications using SocketIO and several other NodeJS websocket libraries.
+## Getting started
-If you are not familiar with Express head over to the [Express Guides](http://expressjs.com/guide.html) to get an idea. Feathers works the exact same way except that `var app = require('express')();` is replaced with `var app = require('feathers')()`. This means that you can literally drop Feathers into your existing Express 4 application and start adding new services right away. The following guide will walk through creating a basic Todo REST and websocket API with Feathers and MongoDB and also explain how to add authentication and authorization. For additional information also make sure to read through the [API documentation](/api/) later.
+Visit the website at [feathersjs.com](http://feathersjs.com) to read the [Getting started guide](http://feathersjs.com/quick-start/) or learn how to build real-time applications with jQuery, Angular, React, CanJS, iOS, Android - you name it - and Feathers as the backend [in our guides](http://feathersjs.com/learn/).
-To get started with this guide, lets create a new folder and in it
+## A MongoDB REST and real-time API
-> `npm install feathers`
-
-## Your first service
-
-The most important concept Feathers adds to Express is that of __services__. Services can be used just like an Express middleware function but instead are JavaScript objects that provide at least one of the following methods:
-
-```js
-var myService = {
- find: function(params, callback) {},
- get: function(id, params, callback) {},
- create: function(data, params, callback) {},
- update: function(id, data, params, callback) {},
- patch: function(id, data, params, callback) {},
- remove: function(id, params, callback) {},
- setup: function(app, path) {}
-}
-```
-
-This object can be registered like `app.use('/my-service', myService)` which - if configured - makes it available as a REST endpoint at `/my-service` and also through websockets. As usual in NodeJS, `callback` has to be called with the error (if any) first and the data as the second parameter.
-
-### Simple Todo
-
-With those methods available we can implement a very basic Todo service that returns a single Todo using the id passed to the `get` method:
-
-```js
-// app.js
-var feathers = require('feathers');
-var app = feathers();
-var todoService = {
- get: function(id, params, callback) {
- // Call back with no error and the Todo object
- callback(null, {
- id: id,
- text: 'You have to do ' + id + '!'
- });
- }
-};
-
-app.configure(feathers.rest())
- .use('/todos', todoService)
- .listen(3000);
-```
-
-After running
-
-> `node app.js`
-
-You can go to [localhost:3000/todos/dishes](http://localhost:3000/todos/dishes) and should see the following JSON response:
-
-```js
-{
- "id": "dishes",
- "text": "You have to do dishes!"
-}
-```
-
-### CRUD Todos
-
-As you might have noticed, service methods mainly reflect basic [CRUD](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete) functionality. Following up is a longer example with comments for implementing a complete Todo service that manages all Todos in memory:
-
-```js
-// todos.js
-module.exports = {
- // The current id counter
- id: 0,
- // An array with all todos
- todos: [],
-
- // Tries to get a single Todo by its id.
- // Throws an error if none can be found.
- getTodo: function(id) {
- var todos = this.todos;
-
- for(var i = 0; i < todos.length; i++) {
- if(todos[i].id === parseInt(id, 10)) {
- return todos[i];
- }
- }
-
- // If we didn't return yet we can throw an error
- throw new Error('Could not find Todo');
- },
-
- // Return all Todos
- find: function(params, callback) {
- callback(null, this.todos);
- },
-
- // Returns a single Todo by id
- get: function(id, params, callback) {
- try {
- callback(null, this.getTodo(id));
- } catch(error) {
- callback(error);
- }
- },
-
- // Create a new Todo
- create: function(data, params, callback) {
- // Increment the global ID counter and
- // use it as the Todos id
- data.id = this.id++;
- this.todos.push(data);
- callback(null, data);
- },
-
- // Update (replace) an existing Todo with new data
- update: function(id, data, params, callback) {
- try {
- var todo = this.getTodo(id);
- var index = this.todos.indexOf(todo);
-
- data.id = todo.id;
- // Replace all the data
- this.todos[index] = data;
- callback(null, data);
- } catch(error) {
- callback(error);
- }
- },
-
- // Extend the data of an existing Todo
- patch: function(id, data, params, callback) {
- try {
- var todo = this.getTodo(id);
-
- // Extend the existing Todo with the new data
- Object.keys(data).forEach(function(key) {
- if(key !== 'id') {
- todo[key] = data[key];
- }
- });
-
- callback(null, todo);
- } catch(error) {
- callback(error);
- }
- },
-
- // Remove an existing Todo by id
- remove: function(id, params, callback) {
- try {
- var todo = this.getTodo(id);
- var index = this.todos.indexOf(todo);
-
- // Splice it out of our Todo list
- this.todos.splice(index, 1);
- callback(null, todo);
- } catch(error) {
- callback(error);
- }
- }
-}
-```
-
-The above example exports the service as a module from its own file, `todos.js`. This means that in `app.js` we can replace the previous `todoService` with loading that module. In order to parse JSON encoded HTTP bodies we additionally need to install and load the Express [body-parser](https://github.com/expressjs/body-parser):
-
-> `npm install body-parser`
-
-```js
-// app.js
-var feathers = require('feathers');
-var bodyParser = require('body-parser');
-
-var app = feathers();
-var todoService = require('./todos');
-
-app.configure(feathers.rest())
- .use(bodyParser.json())
- .use('/todos', todoService)
- .listen(3000);
-```
-
-Running `app.js` will now provide a fully functional REST API at `http://localhost:3000/todos`. You can test it, for example, using the [Postman](https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en) REST client plugin for Google chrome or via CURL:
-
-
-
+ Build Better APIs, Faster than Ever
+curl 'http://localhost:3000/todos/' -H 'Content-Type: application/json' --data-binary '{ "text": "You have to do dishes!" }'A Feathers SocketIO example
- - - - -``` - -After restarting, going directly to [localhost:3000](http://localhost:3000) with the console open will show what is happening on the HTML page. You can also see the newly created Todo at the REST endpoint [localhost:3000/todos](http://localhost:3000/todos). With the page open, reating a new Todo via the REST API, for example - -curl 'http://localhost:3000/todos/' -H 'Content-Type: application/json' --data-binary '{ "text": "Do something" }'