LinkRest is an active project commissioned and open sourced by NHL under Apache 2.0 license. It was conceived specifically as the server-side counterpart to Ext JS, so it natively supports Ext JS rest proxy, including CRUD, grouping, sorting, filtering, and more. In this session, we'll review Ext JS protocol support. You'll also see extensions that allow the client to safely query the server for specific data and shape the response. We'll cover advanced features, including security, constraints, idempotent methods, and metadata service. We'll show demos and try to allow time for Q&A.

1. LinkRest — Modern RESTful API
Framework for ExtJS Apps
Rouslan Zenetl,
Director of App Development, NHL

2. Q & A
#LinkRest

3. The Problem

4. APIs

5. APIs

6. APIs

7. RESTful APIs

9. API attendants

10. “Is It Worth It?” Toxicity

12. The Solution

14. Skip the middleman

15. No more API attendants

16. Win-win

17. What is LinkRest?

18. LinkRest
What is it?
• . . .a protocol
- fully compatible with Ext.data.proxy.Rest
• . . .an implementation of the protocol
- extensible

19. LinkRest Stack
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..

20. LinkRest Stack
ORM
Cayenne, POJO, more..
ORM
Cayenne, POJO, more..
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..

21. LinkRest Stack
LinkRestLinkRest
ORM
Cayenne, POJO, more..
ORM
Cayenne, POJO, more..
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..

22. LinkRestLinkRest
ORM
Cayenne, POJO, more..
ORM
Cayenne, POJO, more..
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..
ExtJS
ApplicationClient

23. LinkRest
What it is not?
• . . .not a comprehensive application framework (not Spring or Rails)
• . . .not a complete application server
• . . .not an immediate replacement for any of your existing frameworks

24. LinkRest Stack
LinkRestLinkRest
ORM
Cayenne, POJO, more..
ORM
Cayenne, POJO, more..
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..

25. LinkRest Coexists
LinkRestLinkRest
ORM
Cayenne, POJO, more..
ORM
Cayenne, POJO, more..
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..
Existing APIs

26. LinkRest
Factoids
• LinkRest is a project commissioned and open sourced by NHL under Apache 2.0
license
• It was conceived specifically as the server-side counterpart to ExtJS
• First released on May 15, 2014
• Hosted on github.com/nhl/link-rest
• Current version is 2.2
• 60+ apps in production

27. Compatibility
Cayenne ORM, JDBC
• DBs supported by Cayenne
- DB2, Derby, FireBird, FrontBase, HSQLDB,
H2, Ingres, MySQL, Oracle (10i, 8, 8i, 9i),
PostgreSQL (7.4, 8.*), SQLite 3.*,
SQLServer, Sybase
• Alternative ORMs possible
• ORM-free is also supported (POJO)
- transient objects, e.g. session, status, etc.
LinkRestLinkRest
ORM
Cayenne, POJO, more..
ORM
Cayenne, POJO, more..
Data Storage
JDBC, NoSQL, more..
Data Storage
JDBC, NoSQL, more..

28. Basic LinkRest

29. # Create a model (or a batch)
POST http://localhost/senchacon/rest/team
# Update a model
PUT http://localhost/senchacon/rest/team/42
# Delete a model
DELETE http://localhost/senchacon/rest/team/42
# Get a single model
GET http://localhost/senchacon/rest/team/42
# Get a collection of models
GET http://localhost/senchacon/rest/team
# Get a sorted collection of models
GET http://localhost/senchacon/rest/team?sort=abbrev
Ext.data.proxy.Rest
Support
• CRUD
• batchActions:true supported
• Paging (start/limit)
• Sorting
• Autocomplete (combo query)
• Filtering (operator, disabled)

30. Demo DB Schema

31. Demo DB Schema
We’ll use this simple database for demos today (NOT
REAL DATA)

32. package com.nhl.senchacon.rest;
@Path("team")
@Produces(MediaType.APPLICATION_JSON)
public class TeamResource {
@Context
private Configuration config;
@GET
public DataResponse<Team> teams(
@Context UriInfo uriInfo) {
return LinkRest
.select(Team.class, config)
.uri(uriInfo)
.select();
}
@PUT
@Consumes(MediaType.APPLICATION_JSON)
@Path("{id}")
public DataResponse<Team> update(
@PathParam("id") int id,
String data,
@Context UriInfo uriInfo) {
return LinkRest.update(Team.class, config)
.uri(uriInfo)
.syncAndSelect(data);
}
}
TeamResource.java

33. Demo Teams Grid

34. LinkRest Features

35. LinkRest Features
LinkRest protocol extensions and functionality
enhancements
• LinkRestProxy
• include/exclude
• object include
• filters and sorters
• cayenneExp (JPA)
• EntityProperty (entity encoder)
• POJO encoding
• mapBy
• Multi-source
• Idempotent updates (and creates)
• Meta-data service

36. Security

37. Authorization

38. Security
Authorization

39. Constraints

40. Security
Constraints
• Underimplement HTTP methods
• Trim ORM graph of unnecessary relationships
• @ClientReadable / @ClientWritable
• Constraints

41. Getting Started

42. github.com/nhl

43. github.com/bootique

44. The Future

45. Q & A
#LinkRest

46. Further Information
Please contribute!
github.com/nhl/link-rest
github.com/nhl
@rzenetl