API Ruby On Rails 5: Aprenda a criar facilmente

E ai programador(a), você sabe como criar uma API Ruby on Rails rapidamente?

API’s são maneiras de conectar serviços, com elas é possível se conectar ao Google para traduzir uma frase ou ao Watson da IBM para realizar um processamento de linguagem natural.

Saber como criar e consumir API’s é fundamental para qualquer programador, então nessa pequena série com 3 vídeos nós vamos ver o que é essencial para criar uma usando Ruby On Rails.

O que vamos utilizar

Planejando nossa API

Preparando a base da API

Gerando nosso Projeto

1 – Rode no console

rails new OneBitContacts --api

1	rails new OneBitContacts --api

*Se quiser utilizar o PostgreSQL adicione ao comando:

--database=postgresql

1	--database=postgresql

Versionando a API

1 – Dentro da pasta controllers crie uma pasta chamada api

2 – Dentro da pasta criada crie uma nova pasta chamada v1

3 – Dentro da pasta criada crie um arquivo chamado api_controller.rb e coloque nele:

module Api::V1

 class ApiController < ApplicationController

   # Métodos globais

 end

end

module Api::V1

class ApiController < ApplicationController

# Métodos globais

end

Habilitando o CORS

Acrescente no seu Gemfile:

gem 'rack-cors'

1	gem 'rack-cors'

Instale a gem rodando:

bundle install

1	bundle install

Acrescente no seu config/application.rb:

config.middleware.insert_before 0, Rack::Cors do

 allow do

   origins '*'

   resource '*',

     headers: :any,

     methods: %i(get post put patch delete options head)

 end

end

config.middleware.insert_before 0, Rack::Cors do

allow do

origins '*'

resource '*',

headers: :any,

methods: %i(get post put patch delete options head)

end

Configurando o Rack Attack

Acrescente no seu Gemfile:

gem 'rack-attack'

1	gem 'rack-attack'

Instale a Gem:

bundle

bundle

Acrescente em config/application:

config.middleware.use Rack::Attack

1	config.middleware.use Rack::Attack

Crie um arquivo chamado rack_attack.rb no seu config/initializers/ e coloque nele:

class Rack::Attack

 Rack::Attack.cache.store = ActiveSupport::Cache::MemoryStore.new

 # Allow all local traffic

 safelist('allow-localhost') do |req|

   '127.0.0.1' == req.ip || '::1' == req.ip

 end

 # Allow an IP address to make 10 requests every 10 seconds

 throttle('req/ip', limit: 5, period: 5) do |req|

   req.ip

 end

 # Throttle login attempts by email address

 #throttle("logins/email", limit: 5, period: 20.seconds) do |req|

 #  if req.path == '/users/sign_in' && req.post?

 #    req.params['email'].presence

 #  end

 #end

end

class Rack::Attack

Rack::Attack.cache.store = ActiveSupport::Cache::MemoryStore.new

# Allow all local traffic

safelist('allow-localhost') do |req|

'127.0.0.1' == req.ip || '::1' == req.ip

end

# Allow an IP address to make 10 requests every 10 seconds

throttle('req/ip', limit: 5, period: 5) do |req|

req.ip

end

# Throttle login attempts by email address

#throttle("logins/email", limit: 5, period: 20.seconds) do |req|

# if req.path == '/users/sign_in' && req.post?

# req.params['email'].presence

# end

#end

end

Instalando o Devise

Acrescente no seu Gemfile:

gem 'devise'

1	gem 'devise'

Instale rodando:

bundle install

1	bundle install

Em config/environments/development.rb coloque:

config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }

1	config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }

Rode no console:

rails generate devise:install

1	rails generate devise:install

Rode no console:

rails generate devise User

rails g migration addNameToUser name:string

rails generate devise User

rails g migration addNameToUser name:string

Gere as migrations:

rails db:migrate

1	rails db:migrate

Devise Simple Token

Adicione ao seu Gemfile:

gem 'simple_token_authentication', '~> 1.0'

1	gem 'simple_token_authentication', '~> 1.0'

Instale rodando:

bundle install

1	bundle install

Adicione ao seu User Model:

acts_as_token_authenticatable

1	acts_as_token_authenticatable

Rode no console:

rails g migration add_authentication_token_to_users "authentication_token:string{30}:uniq"

rake db:migrate

rails g migration add_authentication_token_to_users "authentication_token:string{30}:uniq"

rake db:migrate

Coloque no seu controler api/v1/api_controller.rb:

acts_as_token_authentication_handler_for User

before_action :require_authentication!

private

def require_authentication!

  throw(:warden, scope: :user) unless current_user.presence

end

acts_as_token_authentication_handler_for User

before_action :require_authentication!

private

def require_authentication!

throw(:warden, scope: :user) unless current_user.presence

end

Desenvolvendo e testando nossa API

Gerando nossos Models

Rode no console:

rails g model Contact name:string email:string phone:string description:text user:references

rails db:migrate

rails g model Contact name:string email:string phone:string description:text user:references

rails db:migrate

Adicione ao seu Model Contact:

validates :name, :user, presence: true

1	validates :name, :user, presence: true

Adicione ao seu Model User:

has_many :contacts, dependent: :destroy

1	has_many :contacts, dependent: :destroy

Gerando nossos Controllers

Rode no console:

rails g controller api/v1/contacts

1	rails g controller api/v1/contacts

Coloque no controller gerado:

class Api::V1::ContactsController < Api::V1::ApiController

 before_action :set_contact, only: [:show, :update, :destroy]

 before_action :require_authorization!, only: [:show, :update, :destroy]

 # GET /api/v1/contacts

 def index

   @contacts = current_user.contacts

   render json: @contacts

 end

 # GET /api/v1/contacts/1

 def show

   render json: @contact

 end

 # POST /api/v1/contacts

 def create

   @contact = Contact.new(contact_params.merge(user: current_user))

   if @contact.save

     render json: @contact, status: :created

   else

     render json: @contact.errors, status: :unprocessable_entity

   end

 end

 # PATCH/PUT /api/v1/contacts/1

 def update

   if @contact.update(contact_params)

     render json: @contact

   else

     render json: @contact.errors, status: :unprocessable_entity

   end

 end

 # DELETE /api/v1/contacts/1

 def destroy

   @contact.destroy

 end

 private

   # Use callbacks to share common setup or constraints between actions.

   def set_contact

     @contact = Contact.find(params[:id])

   end

   # Only allow a trusted parameter "white list" through.

   def contact_params

     params.require(:contact).permit(:name, :email, :phone, :description)

   end

   def require_authorization!

     unless current_user == @contact.user

       render json: {}, status: :forbidden

     end

   end

end

class Api::V1::ContactsController < Api::V1::ApiController

before_action :set_contact, only: [:show, :update, :destroy]

before_action :require_authorization!, only: [:show, :update, :destroy]

# GET /api/v1/contacts

def index

@contacts = current_user.contacts

render json: @contacts

end

# GET /api/v1/contacts/1

def show

render json: @contact

end

# POST /api/v1/contacts

def create

@contact = Contact.new(contact_params.merge(user: current_user))

if @contact.save

render json: @contact, status: :created

else

render json: @contact.errors, status: :unprocessable_entity

end

# PATCH/PUT /api/v1/contacts/1

def update

if @contact.update(contact_params)

render json: @contact

else

render json: @contact.errors, status: :unprocessable_entity

end

# DELETE /api/v1/contacts/1

def destroy

@contact.destroy

end

private

# Use callbacks to share common setup or constraints between actions.

def set_contact

@contact = Contact.find(params[:id])

end

# Only allow a trusted parameter "white list" through.

def contact_params

params.require(:contact).permit(:name, :email, :phone, :description)

end

def require_authorization!

unless current_user == @contact.user

render json: {}, status: :forbidden

end

Ajustando as Rotas

Atualize o seu arquivo routes.rb colocando:

Rails.application.routes.draw do
  devise_for :users
  namespace :api do
    namespace :v1 do
      resources :contacts
    end
  end

  # constraints subdomain: 'api' do
  #   scope module: 'api' do
  #     namespace :v1 do
  #       resources :contacts
  #     end
  #   end
  # end
end

Rails.application.routes.draw do

devise_for :users

namespace :api do

namespace :v1 do

resources :contacts

end

# constraints subdomain: 'api' do

# scope module: 'api' do

# namespace :v1 do

# resources :contacts

# end

end

Testando nossos endpoints

Teste usando Postman ou CURL como no vídeo

Desafios

1 – Paginar os retornos do endpoint /contacts

2 – Criar a estrutura para permitir a inclusão de multiplos endereços nos Contatos

Link para o Gihtub: https://github.com/leonardoscorza/api-completa-rails

Gostou de aprender a criar uma API Ruby On Rails do zero? Comenta aí em baixo para eu saber. 🙂

Obrigado pela sua presença,
Grande abraço!

Leonardo Scorza

12 formas de vencer o bloqueio criativo e escrever textos memoráveis (e 6 dicas extras)

Não perca nenhum conteúdo

Receba nosso resumo semanal com os novos posts, cursos, talks e vagas o/

Primeira vez no OneBitCode? Curtiu esse conteúdo?
O OneBitCode tem muito mais para você!

O OneBitCode traz conteúdos de qualidade, e em português, sobre programação com foco em Ruby on Rails e também JavaScript.
Além disso, aqui sempre levamos à você conteúdos valiosos sobre a carreira de programação, dicas sobre currículos, portfólios, perfil profissional, soft skills, enfim, tudo o que você precisa saber para continuar evoluindo como Programador(a)!

Fique por dentro de todos os conteúdos o/

Nossas redes sociais:

📹 • https://youtube.com/Onebitcode [Live todas as terças-feiras às 19h)
💻 • https://linkedin.com/company/onebitcode
🙂 • https://facebook.com/onebitcode
📱 • https://instagram.com/one_bit_code
🐦 • https://twitter.com/onebitcode

Nossos cursos:

🥇 • Programador Full Stack Javascript em 8 Semanas
💎 • Curso Completo de Ruby
⚙ • Minicurso: API Rails 5 Completo
🐞 • Minicurso de Testes para Ruby on Rails com RSpec

Espero que curta nossos conteúdos e sempre que precisar de ajuda, fala com a gente!
Estamos aqui para você 🙂

Bem-vindo à família OneBitCode o/

5 3 votes

Article Rating

janeiro 17, 2020

27 Comentários

Oldest

Newest Most Voted

Inline Feedbacks

View all comments

Edson Lima

4 anos atrás

Olá, ótimo artigo.

Mesmo copiando e colando, estou recebendo este erro:

edsonlima@MacPro.local:~/projetos/rails/OneBitContacts$rails generate devise:install
/Users/edsonlima/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/activesupport-5.1.4/lib/active_support/dependencies.rb:286:in `load’: /Users/edsonlima/projetos/rails/OneBitContacts/config/initializers/rack_attack.rb:33: syntax error, unexpected end-of-input, expecting keyword_end (SyntaxError)

Responder

Autor

Leonardo Scorza

4 anos atrás

Reply to Edson Lima

E ai Edson, beleza?
Manda o link do github onde seu projeto está para eu dar uma olhada 🙂
Acredito que seja algum character extra

Responder

Fernando Alves

4 anos atrás

Boa tarde, Artigo excelente, vi que no final do video 2, voce faz um teste criando um usuario pelo rails c, mas quando faço o mesmo teste ele parece não estar ligado a base de dados, que no meu caso deixei o padrão sqlLite, porem eu dou um create e ele me retorna o que enviei como parametro e os outros campos do User com nil, mas não grava e nem gera o created_at e nem o autenticate. Uma coisa que notei é que quando voce da o rails c, aparece um numero como prefixo, e o meu esta aparecendo… Read more »

Responder

Fernando Alves

4 anos atrás

Achei o problema, era o banco de dados do sqlite que estava errado no database.yml. Tudo certo

Abraço.

Responder

Autor

Leonardo Scorza

3 anos atrás

Reply to Fernando Alves

Boa Fernando,
Valeu \o/

Responder

jmcabanga

4 anos atrás

Cara estava a seguir o tutorial e ao fazer o teste esta a me retornar isso
“status”: 404,
“error”: “Not Found”,
“exception”: “#”,

o get que estou a testar com ele é “http://localhost:3000/api/v1/contacts.json”

Responder

Autor

Leonardo Scorza

3 anos atrás

Reply to jmcabanga

E ai cara, beleza?
Me chama por aqui que eu te dou um help: https://www.facebook.com/leonardo.scorzadesouza
Abraço

Responder

guilhermereisdeveloper

3 anos atrás

Bom dia Leonardo Scorza, no seu ultimo exemplo das “Routes” você esqueceu de colocar o devise, eu olhei o seu código no github, e la na sua “Routes” tinha o “devise_for :users” e no tutorial aqui você não colocou, acho que a galera deve ter ficado meio perdida com os erros. Gostei do seu tutorial apesas de sofrer um pouco kkk. vlw abraços!!

Responder

Autor

Leonardo Scorza

3 anos atrás

Reply to guilhermereisdeveloper

E ai Guilherme, beleza?
Opa, fico feliz que você tenha acompanhado o tutorial 🙂
Obrigado pelo feedback, ajustei o post nesse ponto.
Valeu \o/

Responder

guilhermereisdeveloper

3 anos atrás

De nada mano, gosto dos seus tutoriais!!

Responder

Axel

3 anos atrás

Bacana dms, ótimo artigo. Só estou tendo um problema tentei fazer usando um nome de model diferente de contact, e não estou conseguindo.

Responder

Autor

Leonardo Scorza

3 anos atrás

Reply to Axel

E ai Axel, beleza?
Quais problemas? 🙂

Responder

Carlos Fagiani Junior

3 anos atrás

Muito bem explicado, parabéns,

Vai ter uma parte de login na API?

Responder

KEVIN COSTA MARTINS

3 anos atrás

Reply to Carlos Fagiani Junior

também gostaria foi uma parte que fiquei em duvida

Responder

Hildebrando Segundo

3 anos atrás

Reply to Carlos Fagiani Junior

Também fiquei em duvida em relação a isso, principalmente em delimitar o tempo do token.

Responder

Edson

3 anos atrás

Tem algum tutorial no OneBitCode, que mostre como integrar essa a API nesse tutorial com algum frontend?

Responder

Edson

3 anos atrás

Tem algum tutorial no OneBitCode, mostrando como integrar essa API com um Frontend?

Responder

Edson

3 anos atrás

Teria algum artigo mostrando com integrar essa api com o Front?

Responder

Dieterich

2 anos atrás

Muito Bom!

Responder

Ezequiel

2 anos atrás

quando faço requisição de todos os contatos, o retorno e isso, alguem sabe pq o metodo n ta definido?

NoMethodError (undefined method `contacts’ for #):

Responder

Autor

Leonardo Scorza

2 anos atrás

Reply to Ezequiel

Bom dia Ezequiel,
Verifique se o seu controller está igual ao da aula.
Grande abraço

Responder

Alessandro Moreira

2 anos atrás

Sobre o versionamento, teremos por exemplo 10,20,30 pastas V30 para cada versão, duplicando pastas, codigo, o arquivo de routes vai ficar gordo. É assim mesmo ?

Responder

Autor

Leonardo Scorza

2 anos atrás

Reply to Alessandro Moreira

Alessandro, o normal é você acabar tendo 2 ou 3 versões no máximo (exp: a API do Google Maps está na versão 3 depois de anos), isso não será um problema 🙂

Responder

Bruno

1 ano atrás

Olá, primeiramente ótimo artigo!

Estou tendo esse problema ao seguir os passos do postman na aula 3, já criei o emal, senha e recebi o token, adicionei nos headers mas continuo com o problema(Já estava acontecendo antes msm de adicionar o emal e token nos headers).

ActionController::RoutingError (undefined method ` before_action’ for Api::V1::ContactsController:Class
Did you mean? before_action):

Responder

Nicoly

1 ano atrás

Eu segui todos os passos e a aplicação roda localmente sem problemas, mas quando tento acessar pelo postman recebo o seguinte erro:
#<NameError: uninitialized constant ApplicationController>

Responder

Ane

1 ano atrás

Quando eu tento usar o postman recebo esse erro> > “error”: “You need to sign in or sign up before continuing.”

Responder

Gabriel

8 meses atrás

Excelente artigo

Last edited 8 meses atrás by Gabriel

Responder

API Ruby On Rails 5: Aprenda a criar facilmente

O que vamos utilizar

Planejando nossa API

Preparando a base da API

Desenvolvendo e testando nossa API

Desafios

Não perca nenhum conteúdo

Receba nosso resumo semanal com os novos posts, cursos, talks e vagas o/

Primeira vez no OneBitCode? Curtiu esse conteúdo? O OneBitCode tem muito mais para você!

Nossas redes sociais:

Nossos cursos:

Primeira vez no OneBitCode? Curtiu esse conteúdo?
O OneBitCode tem muito mais para você!