grape rails接口应用

1.简介
随着 Mobile App 的增多,很多时候我们在做用 Rails 做 API Base 项目时,rails 自带的 C 和 V 层显得过于繁杂,grape 可以帮助我们快速的构建和 Rails 完美融合的 API 接口。

2.安装

#gemfile 添加:
gem 'grape', '~> 1.0.2' #当前稳定版本

app文件下创建api文件夹,相关接口都在这

#在config/application.rb 下添加
config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb')
config.autoload_paths += Dir[Rails.root.join('app', 'api', '*')]

3.编写相关接口(简单写了两种写法)

#app/api/test_api.rb
class TestAPI < Grape::API #需大写
  format :json
  get 'get_test' do
    {message: "Hello #{params[:name]} via get"}
  end
  post 'post_test' do
    {message: "Hello #{params[:name]} via post"}
  end
  resource :user do
    desc "Return a user."
    get :test  do
      @user = User.first
    end
  end
end

routes.rb:

mount TestAPI => '/'

分别执行:

#根据你运行端口号
$ curl localhost:3000/get_test?name=test  
#=> {"message":"Hello test via get"}
$ curl -d 'name=test'  localhost:3056/post_test 
#=>{"message":"Hello test via post"}
$ curl localhost:3000/user/test
#=> user的属性值{id:...}

也可以定义一个文件夹(例如app/api/twitter/api.rb):

module Twitter
  class API < Grape::API
    version 'v1', using: :header, vendor: 'twitter'
    # version 'v1', using: :path
    format :json
    # prefix :api

    resource :grade_schools do
      desc 'Return grade_schools 20 records'
      get :index do
        GradeSchool.limit(20)
      end

      desc 'Return a grade_school.'
      params do
        requires :id, type: Integer, desc: 'GradeSchool id.'
      end
      route_param :id do
        get do
          GradeSchool.find(params[:id])
        end
      end

      desc 'Create a grade_school.'
      params do
        requires :grade_school, type: String, desc: 'grade_school paramters.'
      end
      post do
        GradeSchool.create!({ name: params[:name],
                              grade: params[:grade] })
      end

      desc 'Update a grade_school.'
      params do
        requires :id, type: String, desc: 'grade_school ID.'
        requires :grade, type: String, desc: 'Your grade_school.grade'
      end
      put ':id' do
        GradeSchool.find(params[:id]).update({grade: params[:grade]})
      end

      desc 'Delete a grade_school.'
      params do
        requires :id, type: String, desc: 'grade_school ID.'
      end
      delete ':id' do
        GradeSchool.find(params[:id]).destroy
      end
    end
  end
end

routes.rb

 mount Twitter::API => '/'

一套增删改查访问操作

相关链接:https://github.com/ruby-grape/grape

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