Rapid API Development with SailsJS

Creating a RESTful API should be the easiest part of your development. You should not have to be a rocket scientist to successfully create a RESTful API. With Sails, you can create a full featured RESTful API in just a few minutes without writing any code. You get create, destroy, update, find, paginate, sort, and filtering out of the box. If you need to add your business logic to any of the methods or create your own methods, you can do that by writing simple JavaScript functions. Once you are ready to implement security, Sails provides policies that can be applied to any REST action to implement email/password, social login or Windows authentication. For data storage, Sails bundles the power ORM, Waterline, which provides a simple data access layer that just works, no matter which one of the more than 30 data storage providers you are using.

This talk will be code heavy as we walk through getting started with Sails and demonstrate how to implement the features of Sails through the creation of an API. As well, I will share the tips and tricks that I have learned using Sails at a Fortune 100 company. You will walk away understanding how and why you should use Sails on your next project. All code covered in the talk with be immediately available for download.

Transcript

1. https://digitaldrummerj.me @digitaldrummerj Justin James Web Developer Microsoft MVP Professional Speaker
2. https://digitaldrummerj.me @digitaldrummerj Create JavaScript Services 2
3. https://digitaldrummerj.me @digitaldrummerj Auto-generated REST APIs 3
4. https://digitaldrummerj.me @digitaldrummerj Any Database 4
5. https://digitaldrummerj.me @digitaldrummerj Flexible and Configurable 5
6. https://digitaldrummerj.me @digitaldrummerj Security 6
7. https://digitaldrummerj.me @digitaldrummerj Built-On Top of 7
8. https://digitaldrummerj.me @digitaldrummerj Why I Love Sails 8
9. https://digitaldrummerj.me @digitaldrummerj Ridiculously Fast 9
10. https://digitaldrummerj.me @digitaldrummerj Just Works 10
11. https://digitaldrummerj.me @digitaldrummerj Does NOT hide the magic 11
12. https://digitaldrummerj.me @digitaldrummerj 12
13. https://digitaldrummerj.me @digitaldrummerj tiny amounts of code gets you a ton! 13
14. https://digitaldrummerj.me @digitaldrummerj Getting Started 14
15. https://digitaldrummerj.me @digitaldrummerj Install 15
16. https://digitaldrummerj.me @digitaldrummerj Setup npm install –g sails 16
17. https://digitaldrummerj.me @digitaldrummerj Create Project sails new [Project Name] Select #2 – Blank App 17
18. https://digitaldrummerj.me @digitaldrummerj Start Sails Server sails lift 18
19. https://digitaldrummerj.me @digitaldrummerj Debug API sails inspect 19
20. https://digitaldrummerj.me @digitaldrummerj Interactive Console sails console 20
21. https://digitaldrummerj.me @digitaldrummerj Generate sails generate [type] [name] 21
22. https://digitaldrummerj.me @digitaldrummerj represents a record usually maps to db table attributes map to columns Models 22 sails generate model
23. https://digitaldrummerj.me @digitaldrummerj Many to Many One to Many One to One Reflexive One Way Model Associations 23
24. https://digitaldrummerj.me @digitaldrummerj Create customToJSON Use _.omit to remove field Useful for removing secret fields Model Custom JSON Serialization 24
25. https://digitaldrummerj.me @digitaldrummerj Dictionary of actions Responds to requests Bound to routes Controllers sails generate controller 25
26. https://digitaldrummerj.me @digitaldrummerj Responds to requests Bound to routes Structured way to create an action 1 file per action Self-documenting and validating Action sails generate action [ctrl/name] 26
27. https://digitaldrummerj.me @digitaldrummerj Responses to actions Standard responses included Can create custom responses Responses 27 sails generate response
28. https://digitaldrummerj.me @digitaldrummerj 200 – ok, send 500 - serverError 404 - notFound 403 - forbidden 400 – badRequest [Code] – json, send Standard Responses 28
29. https://digitaldrummerj.me @digitaldrummerj reusable code available across whole app Helpers 29 sails generate helper
30. https://digitaldrummerj.me @digitaldrummerj Exposes a set of commonly-used functions as Sails helpers Examples: password: hash and check gravatar: get avatar url stripe: bill info and charging Optional Helpers npm i sails-hook-organics --save 30
31. https://digitaldrummerj.me @digitaldrummerj Generates both Model and Controller API 31 sails generate api
32. https://digitaldrummerj.me @digitaldrummerj Using Api POST http://localhost:1337/<Name> GET http://localhost:1337/<Name> GET http://localhost:1337/<Name>/:id PATCH http://localhost:1337/<Name>/:id DELETE http://localhost:1337/<Name>/:id 32
33. https://digitaldrummerj.me @digitaldrummerj Override Controller Example module.exports = { find: function findFn(req, res) {}, // GET findOne: function findOneFn(req, res) {}, // GET/id create: function createFn(req, res) {}, // POST update: function updateFn(req, res) {}, // PUT destroy: function deleteFn(req, res) {}, // DELETE } 33
34. https://digitaldrummerj.me @digitaldrummerj Override Controller Example module.exports = { find: function findFn(req, res) {}, // GET findOne: function findOneFn(req, res) {}, // GET/id create: function createFn(req, res) {}, // POST update: function updateFn(req, res) {}, // PUT destroy: function deleteFn(req, res) {}, // DELETE } 34
35. https://digitaldrummerj.me @digitaldrummerj Override Controller Example module.exports = { find: function findFn(req, res) {}, // GET findOne: function findOneFn(req, res) {}, // GET/id create: function createFn(req, res) {}, // POST update: function updateFn(req, res) {}, // PUT destroy: function deleteFn(req, res) {}, // DELETE } 35
36. https://digitaldrummerj.me @digitaldrummerj Override Controller Example module.exports = { find: function findFn(req, res) {}, // GET findOne: function findOneFn(req, res) {}, // GET/id create: function createFn(req, res) {}, // POST update: function updateFn(req, res) {}, // PUT destroy: function deleteFn(req, res) {}, // DELETE } 36
37. https://digitaldrummerj.me @digitaldrummerj Override Controller Example module.exports = { find: function findFn(req, res) {}, // GET findOne: function findOneFn(req, res) {}, // GET/id create: function createFn(req, res) {}, // POST update: function updateFn(req, res) {}, // PUT destroy: function deleteFn(req, res) {}, // DELETE } 37
38. https://digitaldrummerj.me @digitaldrummerj Override Controller Example module.exports = { find: function findFn(req, res) {}, // GET findOne: function findOneFn(req, res) {}, // GET/id create: function createFn(req, res) {}, // POST update: function updateFn(req, res) {}, // PUT destroy: function deleteFn(req, res) {}, // DELETE } 38
39. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE 39
40. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE 40
41. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE 41
42. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE 42
43. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE 43
44. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE 44
45. https://digitaldrummerj.me @digitaldrummerj Override Action Example api\controllers\[controller]\find.js // GET api\controllers\[controller]\find-one.js // GET/id api\controllers\[controller]\create.js // POST api\controllers\[controller]\update.js // PUT api\controllers\[controller]\destroy // DELETE sails generate action [controller]/[action] 45
46. https://digitaldrummerj.me @digitaldrummerj Execute some logic before an action to determine if request is processed Stored in api\policies folder Configured in api\config\policies.js Route Security 46
47. https://digitaldrummerj.me @digitaldrummerj Security – api\policies\isLoggedIn.js module.exports = function(req, res, proceed) { if (req.session.user) return proceed(); return res.forbidden('Please Login First.'); }; 47
48. https://digitaldrummerj.me @digitaldrummerj Security – api\policies\isLoggedIn.js module.exports = function(req, res, proceed) { if (req.session.user) return proceed(); return res.forbidden('Please Login First.'); }; 48
49. https://digitaldrummerj.me @digitaldrummerj Security – api\policies\isLoggedIn.js module.exports = function(req, res, proceed) { if (req.session.user) return proceed(); return res.forbidden('Please Login First.'); }; 49
50. https://digitaldrummerj.me @digitaldrummerj Security – api\policies\isLoggedIn.js module.exports = function(req, res, proceed) { if (req.session.user) return proceed(); return res.forbidden('Please Login First.'); }; 50
51. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Controller – config\policies.js module.exports.policies = { UserController: { create: ['isLoggedOut'], login: true, '*': ['isLoggedIn'], }, TodoController: { '*': ['isLoggedIn'] } } 51
52. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Controller – config\policies.js module.exports.policies = { UserController: { create: ['isLoggedOut'], login: true, '*': ['isLoggedIn'], }, TodoController: { '*': ['isLoggedIn'] } } 52
53. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Controller – config\policies.js module.exports.policies = { UserController: { create: ['isLoggedOut'], login: true, '*': ['isLoggedIn'], }, TodoController: { '*': ['isLoggedIn'] } } 53
54. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Controller – config\policies.js module.exports.policies = { UserController: { create: ['isLoggedOut'], login: true, '*': ['isLoggedIn'], }, TodoController: { '*': ['isLoggedIn'] } } 54
55. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Controller – config\policies.js module.exports.policies = { UserController: { create: ['isLoggedOut'], login: true, '*': ['isLoggedIn'], }, TodoController: { '*': ['isLoggedIn'] } } 55
56. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Controller – config\policies.js module.exports.policies = { UserController: { create: ['isLoggedOut'], login: true, '*': ['isLoggedIn'], }, TodoController: { '*': ['isLoggedIn'] } } 56
57. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Action – config\policies.js module.exports.policies = { 'user/*': ['is-logged-in'], 'user/create': ['is-logged-out'], 'user/login': true, 'todo/*': ['is-logged-in'], } 57
58. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Action – config\policies.js module.exports.policies = { 'user/*': ['is-logged-in'], 'user/create': ['is-logged-out'], 'user/login': true, 'todo/*': ['is-logged-in'], } 58
59. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Action – config\policies.js module.exports.policies = { 'user/*': ['is-logged-in'], 'user/create': ['is-logged-out'], 'user/login': true, 'todo/*': ['is-logged-in'], } 59
60. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Action – config\policies.js module.exports.policies = { 'user/*': ['is-logged-in'], 'user/create': ['is-logged-out'], 'user/login': true, 'todo/*': ['is-logged-in'], } 60
61. https://digitaldrummerj.me @digitaldrummerj Implement Policy – Action – config\policies.js module.exports.policies = { 'user/*': ['is-logged-in'], 'user/create': ['is-logged-out'], 'user/login': true, 'todo/*': ['is-logged-in'], } 61
62. https://digitaldrummerj.me @digitaldrummerj Allows scripts served from other domains Disabled By Default Origin can be array of urls App wide or individual routes CORS 62 config/security.js
63. https://digitaldrummerj.me @digitaldrummerj Attack that forces user to execute unwanted actions on an API they are authenticated with CSRF Tokens tells server they "were where they say they were" Used on all Non-Get request Cross-site request forgery (CSRF) 63 config/security.js
64. https://digitaldrummerj.me @digitaldrummerj Interpret a request sent to a URL, then send back a response Custom or Automatic Routing 64
65. https://digitaldrummerj.me @digitaldrummerj Routes – config/routes.js – Controller Functions // Controller functions module.exports.routes = { 'GET /todo/:id': TodoController.findOne', }; 65
66. https://digitaldrummerj.me @digitaldrummerj Routes – config/routes.js – Actions // Actions module.exports.routes = { 'GET /todo/:id': { action: 'todo/find-one' }, }; 66
67. https://digitaldrummerj.me @digitaldrummerj CODING TIME Todo API - users have to login to see data - users can only see their data - users can only register once - passwords must be hashed - todo items associated to users 67
68. https://digitaldrummerj.me @digitaldrummerj References Documentation: sailsjs.com/ Course: platzi.com/clases/javascript-pro/ Demo Code: github.com/digitaldrummerj/stirtrek-2018-sailsjs 68
69. https://digitaldrummerj.me @digitaldrummerj digitaldrummerj.me digitaldrummerj 69
70. https://digitaldrummerj.me @digitaldrummerj