44
Help us understand the problem. What are the problem?

More than 3 years have passed since last update.

RailsでAPIにCORSを設定する

CORSとは

CORS(Cross-Origin Resource Sharering)は簡単に言うと、クライアントが自分と違うオリジンをもつサーバーからデータを取得する仕組みのことをいいます。
オリジン(ex. http://www.example.com:3000)はスキームhttp://、ホストwww.example.com、ポート3000の組み合わせからなります。
同一オリジンポリシーはセキュリティ保護を目的とし、あるページを開いたときに異なるオリジンのリソースを取得するのをブロックします。(例外になるリソースもあります、詳しくはこちら
そのため、異なるオリジンのリソースを取得するには、そのオリジンのCORSが許可されていなければなりません。

ふむふむ。奥が深そうだ。後日詳しく調べてみます

環境

  • Rails 5.2.3
  • ruby 2.5.1
  • Chrome

実装

便利なgemを使いましょう :cat:

rack-cors

cyu/rack-cors

Gemfile
# Permit cors
gem 'rack-cors'
config/application.rb
# Permit cross origin
config.middleware.insert_before 0, Rack::Cors do
  allow do
    origins "*"
    resource "*",
      headers: :any,
      methods: [:get, :post, :options, :head]
  end
end

* はワイルドカードといい不特定の文字を表します。つまり、何が入っても〜という意味になります。

  • origins (文字列 or 正規表現): どのオリジンを許可するか(APIをうつ側のドメイン)
  • resource (文字列 or 正規表現): 許可したいリソースファイル
  • methods (文字列 or Array or :any): 許可したいHTTPメソッド
  • headers (文字列 or Array or :any): 許可したいHTTPヘッダー

確認方法

方法はいろいろですがいくつか挙げます

ブラウザで確認

GETリクエストの場合、ブラウザでアドレスバーにAPI URLを入力してレスポンスが返ってくるか確認できます。
更にレスポンスヘッダーに Access-Control-Allow-Origin がついていることを見るには
Devtool > Network > 該当API > Headers から確認できます。
image.png

Devtoolのconsoleに↓を入力するのでもよいです(ブラウザはChrome)

fetch($API_URL, {
    method: "POST", // ex. GET, POST, PUT, DELETE, etc.
    mode: "cors", 
    body: JSON.stringify($PARAM) // あれば
  })
  .then(res => res.json())
  .then(data => console.log(data)) // レスポンスが返ってくれば成功

curlで確認

# GET
curl -v -H "Origin: ${APIをたたく側のURL}" ${確認したいAPIのURL}
# POST
curl -v -H "Origin: ${APIをたたく側のURL}" -H "Content-Type:application/json" -X POST -d ${リクエストボディ} ${確認したいAPIのURL}

-H: オリジンヘッダーを指定。異なるoriginでないと Access-Control-Allow-Origin がつきません
-v: HTTPリクエストの詳細表示
Access-Control-Allow-Origin が含まれていたら成功です :ok_hand:
image.png

Postmanで確認

GUIでAPIを打ちたいときに便利
Postman | API Development Environment

参考

CORS(Cross-Origin Resource Sharing)について整理してみた | DevelopersIO
CORS (Cross-Origin Resource Sharing) ってなに?

Register as a new user and use Qiita more conveniently

  1. You can follow users and tags
  2. you can stock useful information
  3. You can make editorial suggestions for articles
What you can do with signing up
44
Help us understand the problem. What are the problem?