REST APIs on Rails (v2)

Talk presented at [TDC Florianópolis 2016](http://www.thedevelopersconference.com.br/tdc/2016/florianopolis/trilha-ruby)

Related links:

#### Gems
https://github.com/rails-api/rails-api
https://github.com/bploetz/versionist
https://github.com/rails-api/active_model_serializers

#### Railscasts
http://railscasts.com/episodes/348-the-rails-api-gem
http://railscasts.com/episodes/352-securing-an-api
http://railscasts.com/episodes/350-rest-api-versioning

#### Guides
https://www.airpair.com/ruby-on-rails/posts/building-a-restful-api-in-a-rails-application
http://www.emilsoman.com/blog/2013/05/18/building-a-tested
http://matthewlehner.net/rails-api-testing-guidelines
https://labs.kollegorna.se/blog/2015/04/build-an-api-now
http://www.gotealeaf.com/blog/authentication-methods-in-rails

#### HTTP response code confusions
http://stackoverflow.com/questions/3297048/403-forbidden-vs-401-unauthorized-http-responses/6937030#6937030

#### Rails 5 api
http://wyeworks.com/blog/2015/6/30/how-to-build-a-rails-5-api-only-and-ember-application
http://wyeworks.com/blog/2015/6/11/how-to-build-a-rails-5-api-only-and-backbone-application

#### Discussions
http://joshsymonds.com/blog/2013/02/22/existing-rails-api-solutions-suck/

Transcript

1. REST APIs on Rails
2. Lucas André de Alencar Full Stack Developer, Resultados Digitais
3. Which is the BEST REST API stack ever?!
4. There is no such thing!
5. Follow your heart! <3
6. gem 'rails-api'
7. # instead of class ApplicationController < ActionController::Base end # do class ApplicationController < ActionController::API include ActionController::HttpAuthentication::Token::ControllerMethods include ActionController::MimeResponds include AbstractController::Translation # Your beautiful code goes here! end
9. $ rails new long-trains --api ... $ rails g scaffold train type:string wagons:integer invoke active_record create db/migrate/20150907193647_create_trains.rb create app/models/train.rb invoke test_unit create test/models/train_test.rb create test/fixtures/trains.yml invoke resource_route route resources :trains create app/serializers/train_serializer.rb invoke scaffold_controller create app/controllers/trains_controller.rb invoke test_unit create test/controllers/trains_controller_test.rb
11. Too much copying / pasting between versions No versioning included No documentation system included Disadvantages
12. Versioning
13. URL Request Params HTTP Header api.longtrains.com/v1/trains api.longtrains.com/trains?version=1 Accept: application/json; version=1
14. gem 'versionist'
15. LongTrains::Application.routes.draw do api_version(module: "V1", path: {value: "v1"}) do resources :trains end end URL api.longtrains.com/v1/trains config/routes.rb
16. LongTrains::Application.routes.draw do params = {name: "version", value: "1"} api_version(module: "V1", parameter: params) do resources :trains end end Request Params api.longtrains.com/trains?version=1 config/routes.rb
17. LongTrains::Application.routes.draw do params = {name: "Accept", value: "application/json; version=1"} api_version(module: "V1", header: params) do resources :trains end end HTTP Header Accept: application/json; version=1 config/routes.rb
18. Serializers
19. Run from the ones that use your models!
20. JSON is a representation of data
21. HTML is a representation of data
22. gem 'active_model_serializers'
23. class PostSerializer < ActiveModel::Serializer attributes :title, :body has_many :comments end class CommentSerializer < ActiveModel::Serializer attributes :name, :body belongs_to :post end class PostPreviewSerializer < ActiveModel::Serializer attributes :title, :preview end
24. class PostsController < ApplicationController def show @post = Post.find(params[:id]) render json: @post end def index @posts = Post.all render json: @posts, each_serializer: PostPreviewSerializer end end
25. Security
26. Pure Rails ActionController::HttpAuthentication::Basic ActionController::HttpAuthentication::Digest ActionController::HttpAuthentication::Token
27. Summary rails-api versioning active_model_serializers JSON/HTML is representation of data use pure rails auth for simple authentication
28. Lucas André de Alencar @lucasalencar alencar.lucas.a@gmail.com RD is hiring!