Start on Rails5.0 API

Install

Rails5.0需要ruby2.2.3以上版本

rvm install 2.3.0

gem install rails -v 5.0.0.beta3 --pre

Create

我们要做一个前后端分离的应用,后端只需要返回json,前端使用ReactJS来做渲染。

rails new ToySweet --api

rails5.0的api创建模式使得项目精简了,去掉了rails与浏览器相关的一些功能,例如:

This includes things like sessions, cookies, assets, and really anything related to making Rails work with a browser.
Ref: https://blog.codeship.com/building-a-json-api-with-rails-5/

通过对比中间件(rake middleware),我们可以看到api模式下使用的中间件减少了几项

use Rack::MethodOverride
use WebConsole::Middleware
use ActionDispatch::Cookies
use ActionDispatch::Session::CookieStore
use ActionDispatch::Flash

同时去掉了view,并且ApplicationController继承自ActionController::API

Database

Database使用Postgres, 在Gemfile中加入

gem 'pg'

然后

bundle install

并将config/database.yml中内容替换为

default: &default  
    adapter: postgresql  
    encoding: unicode  
    pool: 5

development:  
    <<: *default  
    database: toysweet_development

test:  
    <<: *default  
    database: toysweet_test

production:  
    <<: *default  
    database: toysweet_production
    username: toysweet  
    password: <%= ENV['TOYSWEET_DATABASE_PASSWORD'] %>

JSON Is Everything

加入active_model_serializers用来定义返回的JSON格式

gem 'active_model_serializers', '~> 0.10.0.rc1'

生成脚手架listing

rails g scaffold listing content:text title:string

生成的信息如下

invoke  active_record
create    db/migrate/20160319091211_create_listings.rb
create    app/models/listing.rb
invoke    test_unit
create      test/models/listing_test.rb
create      test/fixtures/listings.yml
invoke  resource_route
route    resources :listings
invoke  serializer
create    app/serializers/listing_serializer.rb
invoke  scaffold_controller
create    app/controllers/listings_controller.rb
invoke    test_unit
create      test/controllers/listings_controller_test.rb

别忘了还要做一下migrate。Rails5.0中可以统一用rails来替代rake,所以

rails db:
rails db:setup
rails db:migrate

现在访问http://localhost:3000/listings/1,就可以获得listing

{
  data: 
      {
       id: "1",
       type: "listings",
       attributes: 
             {
                content: "nice thing",
                title: "Dog Tower"
             }
       }
}

模型关系

一个user可以有多个listing,而一个listing只属于某一个user

再生成另一个模型User

rails g scaffold user name:string email:string

并在Listing和User中分别添加association

#listings.rb
class Listing < ApplicationRecord  
  belongs_to :user
end

#users.rb
class User < ApplicationRecord
  has_many :listings
end

添加migration

#terminal
rails g migration add_references_to_listings user:references
rails db:migrate

此时两个model间的关联已经建立,于是我们可以这样子创建一个包含有listing的user

#terminal中运行rails c
user = User.create(name: 'Wang Zhiming', email: 'mimimhmh@qq.com')
user.listings.create(title: 'Bike', content: 'Good to have!')

此时访问http://localhost:3000/user/1并不会返回user1包含的listing内容,这是因为返回的json内容是由active_model_serializers来做配置的。

于是做以下修改

#user_serializer.rb
class UserSerializer < ActiveModel::Serializer
  attributes :id, :name, :email
  has_many :listings
end

#listing_serializer.rb
class ListingSerializer < ActiveModel::Serializer
  attributes :id, :content, :title
  belongs_to :user
end

此时再访问http://localhost:3000/user/1不光可以得到user1的内容,还能得到其包含的listing的内容

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容