Udemy 5. RailsAPI×Nuxt.js初めてのAPI通信 #01
2021年01月07日に更新

【Rails6】"Hello" jsonを返すコントローラを作成する

このチャプターで達成すること

今回の「RailsAPI×Nuxt.js初めてのAPI通信」では、開発環境上にボタンを押すと"Hello"が返ってくるアプリケーションを作成します。

完成イメージ

2020-06-22 13-01-40

このアプリケーションを作成することで、RailsとNuxt.jsのAPI通信の基礎を構築します。

アプリの作成手順

このような流れで行います。

  1. docker-compose.ymlにAPI通信に使うURLを登録します。
  2. Railsに"Hello"を返すコントローラーを作成します。
  3. Nuxt.jsにAPIリクエストを送るaxiosのセッティングを行います。
  4. そしてRails側でCORSエラーに対応するGem rack-corsを導入します。

この記事で達成すること

この記事では2つの作業を行います。

  • docker-compose.ymlにAPI通信のURLを登録する
  • Rails側に"Hello"を返すコントローラーを作成する

最終的にブラウザ上にHelloを表示させます。

2020-06-22 13-58-30

それでは作業に入りましょう。

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

Docker環境変数にAPI通信用URLを登録する

docker-compose.ymlにAPI通信用のURLを環境変数として登録します。

  • apiサービスにはenvironmentに「API_DOMAIN」を、
  • frontサービスにはargsに「API_URL」を追加してください。
docker-compose.yml
 api:
  ...
  environment:
    POSTGRES_PASSWORD: $POSTGRES_PASSWORD
    API_DOMAIN: "localhost:$FRONT_PORT"       # 追加
  ...

	front:
    ...
      args:
        WORKDIR: $WORKDIR
        CONTAINER_PORT: $CONTAINER_PORT
        API_URL: "http://localhost:$API_PORT" # 追加    
    ...

frontサービスで指定したargsはDockerfileに渡されます。

そこで「front」ディレクトリのDockerfileに、引数を受け取るARG命令を追加し、環境変数として登録します。

この設定によりNuxt.jsのアプリ内で「API_URL」が参照できるようになります。

front/Dockerfile
FROM node:14.4.0-alpine

ARG WORKDIR
ARG CONTAINER_PORT
# 追加
ARG API_URL

ENV HOME=/${WORKDIR} \
    LANG=C.UTF-8 \
    TZ=Asia/Tokyo \
    # \忘れない
    HOST=0.0.0.0 \
    # 追加
    API_URL=${API_URL}

# ENV check
RUN echo ${HOME}
RUN echo ${CONTAINER_PORT}
# 追加
RUN echo ${API_URL}
...

Dockerfileを書き換えたのでfrontイメージをビルドしましょう。

root $ docker-compose build front

うまく環境変数を渡せていればターミナルにURLが表示されるはずです。

...
Step 8/10 : RUN echo ${API_URL}
 ---> Running in 95e843338d95
http://localhost:3000

OK!これで下準備が終わりました。

Railsにhelloコントローラーを作成する

Railsにhello_controller.rbを作成します。

DockerComposeのrunコマンドを使ってコンテナ内で$ rails generateを実行します。

root $ docker-compose run --rm api rails g controller api::v1::hello

# 成功
create  app/controllers/api/v1/hello_controller.rb
invoke  test_unit
create    test/controllers/api/v1/hello_controller_test.rb
  • api::v1::hello … Railsの「controllers/api/v1」ディレクトリ以下にコントローラーを作成します。

    ディレクトリがなければ自動で作成します。

テストファイルを作成しない--skip-test-frameworオプションは無くなった模様です。

Railsドキュメント

helloコントローラーにアクションを追加する

作成したhello_controller.rbに"Hello"のjsonを返すアクションを追加しましょう。

api/app/controllers/api/v1/hello_controller.rb
class Api::V1::HelloController < ApplicationController
  # 追加
 def index
   render json: "Hello"
 end
end

続いてこのアクションにアクセスするルートを追加します。

routes.rbを開いてください。

api/config/routes.rb
Rails.application.routes.draw do
  # 追加
  namespace :api do
    namespace :v1 do
      # api test action
      resources :hello, only:[:index]
    end
  end
end
  • namespace … 「controllers」以下のディレクトリ階層を表します。

    namespaceを付けた時のRailsのルートはhttp://localhost:3000/api/v1/helloとなります。

helloコントローラーをブラウザで確認する

ここまで出来ればブラウザで確認しておきましょう。

コンテナを起動します。

root $ docker-compose up api

ブラウザからhttp://localhost:3000/api/v1/helloにアクセスしてください。

OK!うまくいっているようですね。Helloが返されています。

2020-06-22 13-58-30

ここまでできたらコンテナを削除しておきましょう。

root $ 「control」+「C」
root $ docker-compose down

確認しておきましょう。

root $ docker-compose ps -a

Name   Command   State   Ports
------------------------------

OK!今回の作業は終わりです。

お疲れっした!

まとめ

今回はComposeファイルに環境変数を登録し、Railsに"Hello"を返すコントローラーを作成しました。

Nuxt.jsで環境変数をDockerfileに渡す理由

そういえばRailsとNuxt.jsで環境変数を渡す場所が違いましたね。

これは、Nuxt.jsのaxiosモジュールの設定のためです。

axiosモジュールでAPI通信に使用するURLは、baseURLというキーに設定します。

そのNuxt.js SPAモードの場合、baseURLは「ビルド時」に設定されます。

「ビルド時」というのは$ yarn buildコマンドを実行したときです。

そのコマンドは、Dockerfile内で実行されます。(これから先の設定で)

なので、コマンド実行前に、Dockerfile内のENV命令を使って環境変数を宣言しています。

これにより、Nuxt.jsからRailsへアクセスするURLが設定される、ということです。


以上でレスポンスの準備が整いました!あとはNuxt.js側のリクエスト処理です。

次回って?

Nuxt.jsにHelloをくれというリクエスト処理を書いていきます。

どうぞお楽しみにー。

(↓のリストからどうぞ)

修正情報

  • 2021年01月07日

    まとめに「Nuxt.jsで環境変数をDockerfileに渡す理由」を追加しました。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. ログイン前のレイアウト構築 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. ログイン前のレイアウト構築 #02
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
10. ログイン前のレイアウト構築 #03
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
10. ログイン前のレイアウト構築 #04
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
10. ログイン前のレイアウト構築 #05
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
10. ログイン前のレイアウト構築 #06
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
10. ログイン前のレイアウト構築 #07
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
10. ログイン前のレイアウト構築 #08
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
10. ログイン前のレイアウト構築 #09
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10. ログイン前のレイアウト構築 #10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
11. ログイン後のレイアウト構築 #01
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
11. ログイン後のレイアウト構築 #02
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
11. ログイン後のレイアウト構築 #03
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
11. ログイン後のレイアウト構築 #04
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
11. ログイン後のレイアウト構築 #05
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
12. サーバーサイドのログイン認証 #01
JWTとは何か?(ruby-jwtのインストール)
12. サーバーサイドのログイン認証 #02
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
12. サーバーサイドのログイン認証 #03
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
12. サーバーサイドのログイン認証 #04
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
12. サーバーサイドのログイン認証 #05
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
12. サーバーサイドのログイン認証 #06
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
12. サーバーサイドのログイン認証 #07
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
12. サーバーサイドのログイン認証 #08
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
13. フロントエンドのログイン認証 #01
【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定
13. フロントエンドのログイン認証 #02
【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する
13. フロントエンドのログイン認証 #03
【Nuxt.js】ローカルストレージの有効期限を暗号化する(crypto-js解説)
13. フロントエンドのログイン認証 #04
【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装
13. フロントエンドのログイン認証 #05
【Nuxt.js】ログイン前後のリダイレクト処理をミドルウェアで実装する
13. フロントエンドのログイン認証 #06
【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する
13. フロントエンドのログイン認証 #07
【Nuxt.js】エラーページを作成する
13. フロントエンドのログイン認証 #08
【Rails×Nuxt.js】デモプロジェクトの作成とHerokuデプロイ(ログイン認証完)
14. 本番環境への対応 #01
【Rails×Nuxt.js】SafariのクロスサイトCookie保存拒否に対応する
SPA開発
ブログ構築
小ネタ集