5 Ways to Build Better Web APIs with Ruby and Rails

5 Ways to Build Better Web APIs with Ruby and Rails

• 1.
  5 Ways toBuild Better Web APIs in Ruby
• 2.
  1. Select theright API framework and gems
• 3.
  Rails isn't alwaysthe right answer
• 4.
  Not all frameworksare == Ramaze Scorched Rails Sinatra NYNY Nancy Rambutan Brooklyn Rack::Response Hobbit Cuba Rack 0 2000 4000 6000 8000 Requests/sec (Higher is better) 10000
• 5.
  Neither are ORMs… Sequel Datamapper AR3.2 new(hash) new() Hash Class 0 2 4 6 8
• 6.
  Select a Serializer Selecta gem or approach that can build JSON, XML, and (perhaps) any future format as well. (I like Roar + Representable)
• 7.
  Pro Tip: Selectyour frameworks and gems based on your actual needs (not what someone else says)
• 8.
  2. Prototype YourAPI
• 9.
  Ways to Prototype Staticfiles – manual response for GET only Stubbed controllers – works for all request types Heroku Dataclips – great for a quick way to build SQL-to-JSON for GET requests
• 10.
  3. Acceptance test yourAPIs
• 11.
  TDD APIs FTW! Acceptancetests will ensure you write better APIs by mimicking how developers will consume your API
• 12.
  What should youuse? RSpec, Cucumber, ??? One is not better than another Use a testing framework so a failure should break your build and report on what failed
• 13.
  4. Select theright API tools
• 14.
  Examples of APITools Exploration: POSTman Chrome Plugin Documentation: RAML, Runscope, APIDesigner Debugging: RunScope, SOAPUI Auth/token and portal mgmt: Layer 7, Apigee, Mashery, 3Scale, Stormpath and many others…
• 15.
  5. Improve thedeveloper experience
• 16.
  Rails trained usto think CRUD
• 17.
  Stop painting yourAPIs with CRUD to solve problems
• 18.
  Take an outside-indesign What is the problem? How does the world view the problem? How does your API solve their problem?
• 19.
  Document your API Buildexamples for quick wins Speak in their terms
• 20.
  Thank you. james@launchany.com @launchany http://bit.ly/better-ruby-apis