RailsでAPIを作るときのエラー処理について | Yucchiy's Note
RailsでAPIを雑に書いていたんだけど, コントローラとかをどう書くとエラー処理しやすくなっていいかなーと考えていて, 個人的に考えがまとまったのでブログ書いた. ※9/1に追記書いた. 良いエラー処理について 個人的にAPIを書く上で(API書くに限らない気はするけど)どういうふうにエラー処理を行うと良いかなーと考えてみると コントローラ内では基本的に, ある関数の処理が失敗して, 次の処理が行えない場合はすべて例外を投げる 例外は各々のコントローラ内で例外のキャッチは行わず, すべてApplicationControllerなど, 親コントローラ内の1メソッドで完結させる かなーと思う. APIのエラー処理は, Envelopeにステータスコードとエラーメッセージを書いて, APIのフォーマットを統一するほうがクライアントが作りやすそうだし, またこのように処理することで, エラー
RailsのGrapeとJbuilderでAPI開発 - ぴよログ
RailsでAPIを作るならGrapeを使うってのが定番っぽいので使ってみました。 参考にしたのはこのへん intridea/grape Ruby - RailsとGrapeで行う最高のWeb API開発 - Qiita Grapeの導入〜Hello World インストールはgem installすればOKです。次にAPIの実装コードを書くファイルを用意します。僕は#{Rails.root}/app/api/api.rbとしました。 # app/api/api.rb class API < Grape::API format :json resource :items do get '/hello' do {hello: "world"} end end end そしてroutes.rbにてGrapeをマウントします。 # routes.rb mount API => "/api" AP
Ruby の HTTP クライアントライブラリ Faraday が便利そう
Ruby の HTTP クライアントライブラリ Faraday が便利そう Ruby の HTTP クライアントライブラリ Faraday が便利そう API ラッパの開発には RestClient gem だとか OAuth の必要なものは Net/HTTP + OAuth gem を使ってた Twitter gem や Instagram gem など API ライブラリのソースを読んでみると Faraday gem というものがよく使われてた なんとなく気になったので Faraday について調べてみた ついでに Tumblife gem を Faraday を使うようにした 以下そのメモ Faraday って何？ Faraday is an HTTP client lib that provides a common interface over many adapters (su
Yoで学ぶはじめてのAPI開発 - pblog
Yoしてますか。 どうやら、Yo APIとやらがある模様。遊んでみます。Yoされたら、ツイッターでやぁするやつを作ってみます。 #ちょっと何言ってんのか 今回は、YAHYAHWORKSにYoすると、@yahyahworks がナンカ言うやつを作ります。 heroku アプリケーションを作成 heroku create ppworks-yo 悲しい事故が起きないようにremoteの名前を変えておく。 git remote rename heroku ppworks-yo これは、複数のherokuアプリケーションを管理していることを考慮して 間違えて別のローカルリポジトリから意図せずherokuにpushしてしまう ことを防ぐためです。git push heroku master でリリースできるのは便利なのですが、herokuのどのアプリケーションにdeployしようとしているかのコンテキ
10 Best Practices for Better RESTful API | Thinking Mobile
Do not use verbs: /getAllCars /createNewCar /deleteAllRedCars 2. GET method and query parameters should not alter the state Use PUT, POST and DELETE methods instead of the GET method to alter the state. Do not use GET for state changes: GET /users/711?activate or GET /users/711/activate 3. Use plural nouns Do not mix up singular and plural nouns. Keep it simple and use only plural nouns for all r
HerokuのAPIデザイン
Herokuが自ら実践しているAPIデザインガイドをGithubに公開した． “HTTP API Design Guide” このガイドは些細なデザイン上の議論を避けて，ビジネスロジックに集中すること目的としている．Heroku特有なものではなく，一般にも十分適用できる知見となっている． 最近は，モバイル向けにAPIをつくることも多いため，勉強もかねて抄訳した．なお内容は，HTTP+JSONのAPIについて基本的な知識があることが前提となっている． 適切なステータスコードを返す それぞれのレスポンスは適切なHTTPステータスコード返すこと．例えば，“成功"を示すステータスコードは以下に従う． 200: GETやDELETE，PATCHリクエストが成功し，同時に処理が完了した場合 201: POSTリクエストが成功し，同時に処理が完了した場合 202: POSTやDELETE，PATCHリク
jbuilderで良い感じのハッシュ形式のJSONを返したいならこれだけ押さえておけば大丈夫かも - (ﾟ∀ﾟ)o彡 sasata299's blog
2014年04月09日11:24 Ruby JavaScript jbuilderで良い感じのハッシュ形式のJSONを返したいならこれだけ押さえておけば大丈夫かも JSON を返すときに、良い感じにごにょごにょしたいみたいなときってあるじゃないですか。そういうときに jbuilder ではどうやるのかなーと思ってちょっと調べたのでメモしておきます。 基本的な使い方はこんな感じです。 # こう書くと json.user do |json| json.nickname @user.name end # こうなる { "user": { "nickname": "sasata299" } } ただ、これだとキーの部分（"nickname" の部分）が定数となってしまい、変数が使えません。変数を使ってキーを動的に変えたい場合には set! というメソッドを使います。 例えば、"nickname"
RailsのRESTful APIをテストで理解する - ワザノバ | wazanova
http://www.commandercoriander.net/blog/2014/01/04/test-driving-a-json-api-in-rails1 comment | 0 pointsPivotal LabsのEno ComptonがRailsでJSON APIをテスト形式で理解できるように紹介してくれてます。「Railsアプリをてがけると、いずれ、シングルページアプリ、モバイルクライアントのためにRESTful APIが必要になるだろうから練習用に。」ということで、コードはGithubで公開されています。 GET /movies POST /movies GET /movies/:id PUT /movies/:id DELETE /movies/:id 上記のrouteをサポートするために、Railsアプリ + RSpec + FactoryGirlを用意したら、
active_model_serializersを試してみた
active_model_serializersを試してみたのでメモ. active_model_serializersとは名前の通りActiveModelをserializationするためのライブラリ.今の所、jsonへの出力に対応.(他のフォーマットに対応するかはよく解らない) railsでjson出力というと、rabl、後はrails4からデフォルトになったjbuilderがあるが、これらはどちらもテンプレートエンジンで、オブジェクト指向的な書き方が出来なかった. 対して、active_model_serializersは、テンプレートエンジンではなく、出力内容をserializerというクラスに定義するため、オブジェクト指向的な書き方が出来る、というものらしい. インストールGemfile gem 'active_model_serializers' でbundle instal
faraday-lazyable - r7kamura blog
faraday-lazyableという、 HTTPリクエストを遅延評価させるためのライブラリを作った。 遅延評価はある種の複雑性を持ち込むが、ビジネスの要求に合わせて正しく使っていきたい。 遅延評価 HTTPリクエストにおける遅延評価とは何か。 遅延評価というのは、評価しなければならない値が存在するとき、 実際の計算を値が必要になるまで行わないことをいう。 HTTPリクエストを遅延評価するというのは、つまりHTTPクライアントはすぐにレスポンスオブジェクトを返すが、 レスポンスオブジェクトに対してメソッドが呼ばれたときに初めてHTTP通信を発生させるということを意味している。 Faraday Faradayとは何か。 faraday-lazyableは、FaradayというRuby製のHTTPクライアントのプラグインとして実現されている。 FaradayはRackのようにプラグイン(=この
iOSエンジニアにモテるAPIを作るための3つのこと - tanihiro.log
最近、自分でobjective-cをちょこちょこ書いていて、API作る側もちょっと気をつけた方がいいなーと思ったことがありました。 それは、プロパティ名です。 1. "id"を使わない objective-cにはid型があるので、プロパティ名でそのままidを使うとまぁややこしくなるから、APIで渡してあげる時もxxxIdにしてあげると、スッキリします。 2. "newXXX"を使わない なんか、newXXXという変数を定義するとビルドすらできなくなってしまいます。 property's synthesized getter follows Cocoa naming convention for returning 'owned' objects こんなエラーが出ます。 ここらへんに書いてありました。 http://stackoverflow.com/questions/6327448/se
#348 The Rails API Gem - RailsCasts
リッチクライアントの人気が高まる中で、よくあるのは「JSON APIがあればいいだけの場合にもRailsを使うべきか?」という疑問です。そのようなAPIを開発する場合には、RailsコアメンバのSantiago PastorinoによるRails::API gemをお勧めします。このgemのREADMEには、APIを作成したいだけの場合にRailsを利用することの利点について詳しい説明があります。このgemは、Railsのモジュラー性の高さを活かして、APIを作成する場合に不要なものを全部外してスリム化されたRailsアプリケーションを作成するためのジェネレータを提供します。今回のエピソードでは、このgemを使ってとてもシンプルなアプリケーションを作りながらその仕組みを見ていきます。 Rails::APIを使う 最初にgemをインストールするために以下のコマンドを実行します。
池澤あやかのプロフィール - Facebook開発者の為のサポートサイト | fb.developers'+
スマートウォッチはさまざまなブランドから発売されており、とても注目を集めています。しかし、具体的にどのような機能があるのか分からない方もいるでしょう。また数多くの種類があり、どれを選ぶか迷う方も多いですよね。そこで今回は、スマートウォッチの基本的な機能や、おすすめのブランド・商品についてご紹介します。 ＃健康管理 多くのスマートウォッチには、歩数を計測する機能があります。その機能を使用すれば歩数やカロリーなどが計算できて、健康管理に役立つでしょう。 ＃通知機能 メールやSNS（Faceboook、Twitter、Instagramなど)の通知を受け取ることができます。会議中や食事中などでも気軽に確認できるでしょう。 ＃電子マネー決済 対応しているスマートウォッチであれば、さまざまな電子マネー決済が使用できます。財布を取り出さなくてもいいため非常に便利です。 ＃音楽再生 スマホをカバンやポケ
Ruby Twitter Gem by John Nunemaker
Install $ sudo gem install twitter note: the twitter gem now works with hpricot 0.5+ API Wrapping I do my best to keep it easy to use. Below are some code samples showing a few of the methods. twit = twit twit.update('watching veronica mars') puts "Public Timeline", "=" * 50 twit.timeline(:public).each do |s| puts s.text, s.user.name puts end puts '', "Friends Timeline", "=" * 50 twit.timelin
Facebook APIでウォールに投稿/書き込む｜DIGITAL SQUADブログ
Facebook APIでウォールに投稿/書き込む Facebook Graph APIを使ってRailsでfacebookページウォールに投稿する時の手順と知っておきたい注意点のまとめ。 気づいた点や間違いなどは、加筆修正予定。 ■Facebookアプリを作成 Graph APIを利用するには、まずfacebookアプリが必要なので作成する。 作成したらApp ID/API Key、App Secretをメモしておく。 ちなみに、Facebookeの商標やFacebook製のアプリと混同するアプリ名は不可。 ■Facebookアプリのアクセストークン App ID、App Secretを取得したら、アプリのアクセストークンを取得する。access_token = open("https://graph.facebook.com/oauth/access_token?client_id=A
SinatraでTwitter Streaming APIにアクセスする超簡単なWebアプリのつくりかた:Kenn's Clairvoyance
Twitterには、ストリーミングAPIという、プッシュでリアルタイムに情報を受け取ることのできるAPIが用意されています。 これを使えば、定期的にポーリングをしたりすることなく、誰かが発言した時点で即座にメッセージを受け取れます。 しかし、これを使うためには、TCP接続をTwitterに対して張りっぱなしにしておく必要があり、Webアプリなどで使うのに敷居が高いと感じている人もいるのではないでしょうか。 今回は、「そんなことないよ、超簡単だよ」ということを、Rubyベースのサンプルで示したいと思います。 なぜそんなことが簡単にできるのか、その秘密を先に種明かしすると、Ruby用のWebサーバとして急速に人気を獲得し、デファクトの座をとりつつある「Thin」というWebサーバが、内部的にEventMachineという非同期サーバを使用しているので、その機能を使うことで、今までのWebアプリ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
はてブAPIでwebサービスを作りたい全ての人に向けて書きました
【Rails 高速化】ペパボのフリマアプリ「kiteco（キテコ）」の API を高速化したときのことを詳しく書いてみた - 彼女からは、おいちゃんと呼ばれています
http://api.atnd.org/
Amazon Web サービス入門(Product Advertising API)