REST APIs on Rails

Lucas André de Alencar Full Stack Developer, Resultados Digitais

Which is the BEST REST API stack ever?!

There is no such thing!

Follow your heart! <3

gem 'rails-api'

# 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

No content

$ 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

No content

Too much copying / pasting between versions No versioning included No documentation system included Disadvantages

Versioning

URL Request Params HTTP Header api.longtrains.com/v1/trains api.longtrains.com/trains?version=1 Accept: application/json; version=1

gem 'versionist'

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

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

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

Serializers

Run from the ones that use your models!

JSON is a representation of data

HTML is a representation of data

gem 'active_model_serializers'

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

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

Security

Pure Rails ActionController::HttpAuthentication::Basic ActionController::HttpAuthentication::Digest ActionController::HttpAuthentication::Token

Summary rails-api versioning active_model_serializers JSON/HTML is representation of data use pure rails auth for simple authentication

Lucas André de Alencar @lucasalencar alencar.lucas.a@gmail.com RD is hiring!