Grapeを使ったAPIで独自のエラーコードも一緒に返す工夫 - ぴよログ
RailsでGrapeをっていうgemを使うとちょちょいっとAPIが作れるという話は以前にも書いた。 RailsのGrapeとJbuilderでAPI開発 - PILOG Grapeを使ったAPI実装でのネストやパラメータ - PILOG このときはお試しだったんだけど、今回ちょっと本格的に書くかもという感じになってちゃんとエラー処理とかもしないといけなくなった。それにあたり試行錯誤したことをちょっとメモっておこうと思う。 普通にエラーを返す 以下フォーマットはJSONだとする。 エラーはerror!メソッドによって発生させることができる。error!は例外を使っているようなので呼んだ時点で処理が中断するため、エラー発生後の処理のことは考えなくていい。 class API < Grape::API resource :users do get '/' do error!("Unauthor
File: README — Documentation by YARD 0.8.3
What is Grape? Grape is a REST-like API micro-framework for Ruby. It's designed to run on Rack or complement existing web application frameworks such as Rails and Sinatra by providing a simple DSL to easily develop RESTful APIs. It has built-in support for common conventions, including multiple formats, subdomain/prefix restriction, content negotiation, versioning and much more. Project Resources
Rails + Grape + API Key Authentication
When adding a Grape API to an existing Rails application you have a few options for user authentication. Probably the simplest and most basic way to authenticate an API is by issuing API keys to your users. How it works…User submits their Username/Password to the API.API authenticates the user and returns an API Key.For all subsequent API requests, the user submits the key with their request. This
GrapeでAPIを構築時のメモ - Qiita
class Post < ActiveRecord::Base has_many :post_relationships has_many :categories, through: :post_relationships validates :name, presence: true accepts_nested_attributes_for :categories end class PostRelationship < ActiveRecord::Base belongs_to :post belongs_to :category end class Category < ActiveRecord::Base has_many :post_relationships has_many :posts, through: :post_relationships end # api.py
Grape+KaminariでAPIのページング対応 - Qiita
class Post < ActiveRecord::Base paginates_per 5 ... end あとはこんな感じでModel.query().page(params[:page])をつけて書くだけ。 Model.query().page(params[:page]).per(10)見たいな形でモデルに設定した値でなくても取って来れるので、offset,limitみたいな使い方も簡単。 # coding: utf-8 class Post_API < Grape::API resource :posts do # http://localhost:3000/api/v1/posts params do optional :page, type: Integer, desc: "Page Num" end get do Post.where(published: true).p
Grape - RailsでスピーディにAPIを作成！
🗽 APIのサンプルTwitterを模倣したサンプル(?)が、公式のGitHubのREADMEに書かれていたので転載。 app/api/Twitter.rbを作成して、次のようなコードを書きます。 module Twitter class API < Grape::API # versionは:headerや、:paramなどもあり version 'v1', using: :path, vendor: 'twitter' format :json helpers do def current_user @current_user ||= User.authorize!(env) end def authenticate! error!('401 Unauthorized', 401) unless current_user end end resource :statuses do d
Grape を使って Rails アプリに Web API を組み込む - present
Rails アプリに Web API を追加したい。 Rails のコントローラーで実装してもいいんだけど、せっかくなんで、 Web API マイクロフレームワーク『Grape』を試してみた。 Grape | REST-like API micro-framework Gemfile に gem "grape" を追加して bundle install でインストール。 RAILS_ROOT/app/api に api.rb を作成。 RAILS_ROOT/lib に置くか迷ったけど、モデル使うし、Web API もアプリの一部と考えているから app 下に置くことにした。 # coding: utf-8 class API < Grape::API format :json default_format :json prefix "api" version "v1", using: :p
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
