Endpoint is a node.js framework for rapid development of web services. Learn how to leverage endpoint to set up your next API.

1. endpoint
Rapid web service development
Aleksis Brezas
abresas

2. Web service
web client
(backbone, angular, React)
endpoint
JSON/XML
Third party application

3. MVCfunction user_get() {
if (!$this->get('id')) {
$this->response(NULL, 400);
}
$user = $this->User->findById( $this->get('id') );
if(!$user) {
$this->response(array('error' => 'User could not be found'), 404);
}
else {
$this->response($user, 200);
}
}
input
validation
data fetch
error handling
response

4. endpoint = resources + scripts

5. Articles:
uri: '/articles/:id'
properties:
id:
type: id
title:
type: string
maxLength: 255
minLength: 5
unique: true
body:
type: text
resource example
resources/articles.yml

6. RESTful API
GET /articles/
GET /articles/?$order_by=title&$page=4&$per_page=10
POST /articles/
GET /articles/104
PUT /articles/104
PATCH /articles/104
DELETE /articles/104
GET /articles/$metadata

7. Example Request
$ curl -X POST -H ‘Content-Type: application/json’ -d ‘{ “title”: “My first article”,
“body”: “Hello, World!” }’ http://localhost:8080/articles/
{
“id”: 4,
“title”: “My first article”,
“body”: “Hello, World!”,
“created_at”: “2014-06-05T03:14:15.927Z”,
“updated_at”: “2014-06-05T03:14:15.927Z”
}

8. Example Request
$ curl -X POST -H ‘Content-Type: application/json’ -d ‘{ “title”: “Bad”, “body”:
“Too short title” }’ http://localhost:8080/articles/
{
“success”: false,
“error”: “Property ‘title’ should be at least 5 characters.”
}

9. Relations
resources/articles.yml
relations:
comments:
resource: Comment
type: oneToMany
key: article_id
new URLs
GET /articles/104/comments/$page=4
POST /articles/104/comments/
DELETE /articles/104/comments/

10. Queries
queries:
MostDiscussed:
“SELECT * FROM articles
INNER JOIN (SELECT article_id, count(id) AS
count FROM comments GROUP BY article_id) AS c
ON articles.id = c.count
ORDER BY c.count DESC”
API: GET /articles/MostDiscussed/?$page=4

11. Scripts
var email = require( ‘emailjs’ );
exports.onCreate = function( req, article, cb ) {
var address = req.auth.user.email;
var subject = “You have created an article”;
var message = “You have created an article with title
”” + article.title + “”.”;
email.send( address, { subject: subject, message:
message } );
cb();
};

12. Scripts
var app = require( ‘endpoint’ );
// Express
app.get( ‘/custom’, function( req, res, next ) {
// Waterline
app.model( ‘articles’ ).find( … );
} );

13. Philosophy
Resources
Declarative (YAML)
Scripts
Event driven (node.js
modules)
Promise: Write as less repetitive code as
possible

14. Future
Hot Code Loading
Plugin System:
o auth
o date
Generators
$ endpoint init
$ endpoint install auth
$ endpoint generate articles

15. Questions?
http://www.endpointjs.com
http://github.com/venturegeeks/endpoint