Udemy 5. RailsAPI×Nuxt.js初めてのAPI通信 #03
2020年06月23日に公開

【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)

今回達成すること

  • 同一オリジンポリシーとCORSを理解して、

  • RailsにGemrack-corsを導入しCORS設定を行います。

この記事を完走してHelloを返すアプリケーションを完成させましょう。

2020-06-12 18-17-51

※ この記事ではRails(apiディレクトリ内)のファイルを編集します。

現状の確認

コンテナを起動してブラウザからhttp://localhost:8080にアクセスしてください。

root $ docker-compose up

デベロッパーツールも開いておきましょう。

前回作成したボタンを押すと。。。あれ。エラーが返ってきますね。

CORSって何!?

2020-06-12 17-44-21

CORSを理解する前に、このエラーの原因について理解しましょう。

っと。その前にコンテナを削除しときましょう。

root $「control」+「C」
root $ docker-compose rm -f

エラーの原因

画像のエラーは、ブラウザに備わっている同一オリジンポリシーに違反していることで吐き出されたエラーです。

同一オリジンポリシーとは

あるオリジンから読み込まれた文書やスクリプトについて、異なるオリジンからアクセスできないように制限した規約です。

オリジンとは

  • スキーム(http)
  • ドメイン(example.com
  • ポート(8080)

が組み合わさったものを言います。

今回のケースだと「http://localhost:8080」と「http://localhost:3000」をそれぞれ一つのオリジンとみなします。

つまり?(まとめ)

今回のエラーの原因は、

発生したのです。

(参考)オリジンの具体例

同一オリジンポリシーに違反していない

同一オリジンポリシーに違反している

参考

同一オリジンポリシー - ウェブセキュリティ | MDN

Origin (オリジン) - MDN Web Docs 用語集: ウェブ関連用語の定義

CORSとは?

エラーの原因が理解できたところでCORSについて説明します。

CORSとは、Cross-Origin Resource Sharing(クロスオリジンリソースシェアリング)の略で、異なるオリジン間の通信を許可する仕組みです。

上で説明した同一オリジンポリシーは、不正なやりとりを防止すると同時に正当なやりとりも拒否します。

その回避策として用意されているのがこのCORSです。

参考 クロスオリジン リソース シェアリング(CORS) | Cloud Storage

CORS設定の方法

2つあります。

  1. Nuxt.js側にproxy(代理サーバ)を立てて通信を行う方法

    方法 クロスオリジンリソースを共有するには? - Nuxt.js

  2. Rails側でリクエストがくるドメインを許可する方法

ただ1の方法はDockerコンテナ経由だとうまくいかなかった。。。

そこで2のRailsにドメインの許可をする方法で設定していきます。

RailsにGem rack-corsを導入する

Railsに rack-corsを導入し、指定したドメインのアクセスを許可します。

Gemのインストール

「api」ディレクトリのGemfileを開きましょう。

26行目付近のgem 'rack-cors'のコメントを外します。

api/Gemfile
# コメント外す
gem 'rack-cors'

Gemfileを書き換えたのでDockerイメージを再ビルドします。

root $ docker-compose build api

Railsを動かすDockerfileには、$ bundle installが実行されるように記述していますので、ビルドと同時にGemもインストールされます。

ビルドが完了したらrack-corsがインストールされているか確認します。

root $ docker-compose run --rm api bundle info rack-cors

 rack-cors (1.1.1)
 ...

OKですね。

設定ファイルの編集

続いてrack-corsの設定ファイルを編集していきましょう。

「api/config/initializers」直下にあるcors.rbが設定ファイルです。

コード部分のコメントを外してoriginsの部分を書き換えます。

api/config/initializers/cors.rb
# Be sure to restart your server when you modify this file.

# Avoid CORS issues when API is called from the frontend app.
# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.

# Read more: https://github.com/cyu/rack-cors

Rails.application.config.middleware.insert_before 0, Rack::Cors do
  allow do
    origins ENV["API_DOMAIN"] || ""

    resource '*',
      headers: :any,
      methods: [:get, :post, :put, :patch, :delete, :options, :head]
  end
end
  • ENV["API_DOMAIN"] || ""
    • ENV["API_DOMAIN"]の中にはdocker-compose.ymlで指定した値が入っています。
    • || "" … ここにNullが入るとエラーになります。そこで環境変数が存在しない場合は空文字を入れるようにしています。
docker-compose.yml
api:
	...
  environment:
    API_DOMAIN: "localhost:$FRONT_PORT" # この値がENV["API_DOMAIN"]に入る

これでrack-corsの設定は完了です。

エラーが解決したか確認しよう

それではコンテナを起動して、ブラウザで確認してみましょう。

root $ docker-compose up

ボタンを押すと。。。

2020-06-12 18-17-51

Helloが表示され、レスポンスの成功を表す200番も返ってきています。

やった。成功です。

嬉しさのあまりコンテナを削除するのを忘れないでおきましょう。

root $ 「control」+「C」
root $ docker-compose rm -f

ここまでの変更をpushしとく

全てのディレクトリをGitHubにpushしておきましょう。

  • apiディレクトリ
api $ git add -A
api $ git commit -m "add_hello_controller"
api $ git push
  • frontディレクトリ
api   $ cd ../front
front $ git add -A
front $ git commit -m "add_axios.js"
front $ git push
  • rootディレクトリ
front $ cd ..
root  $ git commit -am "finished_hello_API"
root  $ git push

まとめ

さて、今回はRailsのCORS設定を行っていきました。

これで初めてのAPIアプリケーションが完成です。\ o /

このチャプターのまとめ

このチャプター「RailsAPI×Nuxt.js初めてのAPI通信」では以下のことを行ってきました。

以上でチャプター終了です。

次回は新章始まります

次回からは新章「Heroku.ymlを使ったDockerデプロイ」が始まります。

今作ったアプリケーションをネット上に公開するところまでを行います。

いざ!👇のリストへ。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】このカテゴリーで作るアプリケーションの仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
最初の一歩。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
新着
SPA開発
ブログ構築
小ネタ集