Writing RESTful web services using Node.js
•
59 likes•33,280 views
by Jakob Mattsson on Frontend DEV Conf'13 http://bit.ly/Jakob_Mattsson
Recommended
More Related Content
What's hot
What's hot (20)
Similar to Writing RESTful web services using Node.js
Similar to Writing RESTful web services using Node.js (20)
More from FDConf
More from FDConf (20)
Recently uploaded
Recently uploaded (20)
Writing RESTful web services using Node.js
- 3. Started out doing consulting
- 5. 2 000 000 000 writes/day!
- 6. Back to square one
- 7. Writing RESTful web services using Node.js
- 9. Comparison Rocket science Product demo Silver bullet NOT
- 10. What is it then?
- 13. Node.js
- 15. Node.js is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient, perfect for data-intensive real-time applications that run across distributed devices.
- 16. Node.js is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient, perfect for data-intensive real-time applications that run across distributed devices.
- 17. fs = require('fs') fs.readFile 'meaning_of_life.txt', 'utf-8', (err, data) -> console.log(data) console.log('end')
- 18. end 42
- 19. Several protocols, including TCP and HTTP, are built in to node.
- 20. http = require('http') onRequest = (req, res) -> res.writeHead(200, { 'Content-Type': 'text/plain' }) res.end('Hello Worldn') http.createServer(onRequest).listen(1337)
- 21. npm
- 22. npm is a package manager for node. You can use it to install and publish your node programs. ”It manages dependencies and does other cool stuff.”
- 24. _ = require('underscore') numbers = _.range(1, 10) console.log(_.last(numbers))
- 25. Connect
- 26. Connect is a midleware framework for node. It’s shipping with over 18 bundled middleware. It has a rich selection of 3rd-party middleware.
- 28. connect = require('connect') app = connect() app.listen(3000) // last line equivalent to // http.createServer(app).listen(3000);
- 29. connect = require('connect') app = connect() app.use connect.basicAuth (user, pass) -> return user == 'jakob' && pass == 'fdc13' app.use (req, res) -> res.writeHead(200, { 'Content-Type': 'text/plain' }) res.end('Hello Worldn') app.listen(3000)
- 30. logger csrf compress basicAuth bodyParser json urlencoded multipart cookieParser session cookieSession methodOverride responseTime staticCache static directory vhost favicon limit query errorHandler Request logger with custom format support Cross-site request forgery protection Gzip compression middleware Basic http authentication Extensible request body parser Application/json parser Application/x-www-form-urlencoded parser Multipart/form-data parser Cookie parser Session management support with bundled MemoryStore Cookie-based session support Faux HTTP method support Calculates response-time and exposes via X-Response-Time Memory cache layer for the static() middleware Streaming static file server supporting Range and more Directory listing middleware Virtual host sub-domain mapping middleware Efficient favicon server (with default icon) Limit the bytesize of request bodies Automatic querystring parser, populating req.query Flexible error handler
- 31. Express
- 32. High performance high class web development for Node.js
- 34. express = require('express') app = express.createServer() app.get '/', (req, res) -> res.send('Hello World') app.get '/users/:id', (req, res) -> res.send('user ' + req.params.id) app.listen(3000)
- 35. express = require('express') app = express.createServer() before1 = (req, res, next) -> req.foo = 'bar' next() before2 = (req, res, next) -> res.header('X-Time', new Date().getTime()) next() app.get '/', before1, (req, res) -> res.send('Hello World') app.get '/users/:id', [before1, before2], (req, res) -> console.log(req.foo) res.send('user ' + req.params.id) app.listen(3000)
- 36. Data storage
- 37. But which one?
- 38. Schemaless is a lie
- 40. Mongoose
- 41. Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment.
- 43. mongoose = require 'mongoose' mongoose.connect 'mongodb://localhost/tamblr' model = (name, schema) -> mongoose.model name, new mongoose.Schema schema, strict: true users = model 'users' name: type: String default: '' bio: type: String default: 'IE6-lover' age: type: Number default: null
- 44. blogs = model 'blogs' name: type: String default: '' description: type: String default: '' users: type: ObjectId ref: 'users'
- 45. posts = model 'posts' title: type: String default: '' body: type: String default: '' published: type: Date blogs: type: ObjectId ref: 'blogs'
- 46. list = (model, callback) -> model.find {}, callback get = (model, id, callback) -> model.findById id, callback del = (model, id, callback) -> model.remove { _id: id }, callback put = (model, id, data, callback) -> model.update { _id: id }, data, { multi: false }, callback post = (model, data, callback) -> new model(data).save callback
- 47. app.get '/users/:id', (req, res) -> get users, req.params.id, (err, data) -> res.json data
- 48. copy-paste!
- 49. POST /users GET /users GET /users/42 DELETE /users/42 PUT /users/42 POST /blogs GET /blogs GET /blogs/42 DELETE /blogs/42 PUT /blogs/42 POST /posts GET /posts GET /posts/42 DELETE /posts/42 PUT /posts/42
- 50. or should we?
- 51. models = [users, blogs, posts] Object.keys(models).forEach (modelName) -> app.get "/#{modelName}", (req, res) -> list models[modelName], (err, data) -> res.json data app.get "/#{modelName}/:id", (req, res) -> get models[modelName], req.params.id, (err, data) -> res.json data app.post "/#{modelName}", (req, res) -> post models[modelName], req.body, (err, data) -> res.json data app.del "/#{modelName}/:id", (req, res) -> del models[modelName], req.parmas.id, (err, count) -> res.json { count: count } app.put "/#{modelName}/:id", (req, res) -> put models[modelName], req.params.id, req.body, (err, count) -> res.json { count: count }
- 52. POST /users GET /users GET /users/42 DELETE /users/42 PUT /users/42 POST /blogs GET /blogs GET /blogs/42 DELETE /blogs/42 PUT /blogs/42 POST /posts GET /posts GET /posts/42 DELETE /posts/42 PUT /posts/42
- 53. But what about the relations/associations?
- 54. POST /users/42/blogs GET /users/42/blogs POST /blogs/42/posts GET /blogs/42/posts
- 55. paths = models[modelName].schema.paths owners = Object.keys(paths).filter (p) -> paths[p].options.type == ObjectId && typeof paths[p].options.ref == 'string' .map (x) -> paths[x].options.ref owners.forEach (owner) -> app.get "/#{owner}/:id/#{name}", (req, res) -> listSub models[name], owner, req.params.id, (err, data) -> res.json data app.post "/#{owner}/:id/#{name}", (req, res) -> postSub models[name], req.body, owner, req.params.id, (err, data) -> res.json data
- 56. POST /users/42/blogs GET /users/42/blogs POST /blogs/42/posts GET /blogs/42/posts
- 58. Authentication
- 59. npm install passport npm install passport-local
- 60. passport = require('passport') passportLocal = require('passport-local') passport.use new passportLocal.Strategy (user, pass, done) -> findUserPlz { username: user, password: pass }, (err, user) -> done(err, user) app.use(passport.initialize()) app.use(passport.authenticate('local'))
- 62. passport = require('passport') twitter = require('passport-twitter') keys = { consumerKey: TWITTER_CONSUMER_KEY consumerSecret: TWITTER_CONSUMER_SECRET callbackURL: "http://127.0.0.1:3000/auth/twitter/callback" } passport.use new twitter.Strategy keys, (t, ts, profile, done) -> findOrCreateUserPlz { twitterId: profile.id }, (err, user) -> done(err, user) app.use(passport.initialize()) app.use(passport.authenticate('twitter'))
- 64. ALL CHARACTERS AND EVENTS IN THIS SHOW-- EVENT THOSE BASED ON REAL PEOPLE--ARE ENTIRELY FICTIONAL. ALL CELEBERTY VOICES ARE IMPERSONATED.....POORLY. THE FOLLOWING PROGRAM CONTAINS COARSE LANGUAGE AND DUE TO ITS CONTENT IT SHOULD NOT BE VIEWED BE ANYONE
- 65. Verbs vs Nouns
- 67. GET /users GET /users/42 POST /users PUT /users/42 DELETE /users DELETE /users/42
- 68. Associations
- 73. /users /blogs /posts /users/42/blogs /blogs/314/posts /users/42/blogs/314/posts Keep URLs short. Don’t overqualify.
- 75. Versions
- 76. GET /v1/users
- 79. Verbs
- 81. Content-types
- 83. Attributes
- 84. { "userId": 1, "firstName": "Jakob", "lastName": "Mattsson" }
- 85. Search
- 87. Authentication
- 90. It goes for ideas too! Reuse convention.
- 91. Reuse code. Resuse ideas. Build new things.
- 94. ”MOST IMPORTANT STEP FOR BUILD PRODUCT IS BUILD PRODUCT” - @fakegrimlock