【Rails】Rails + microCMSで簡単にブログを作成

2021年4月5日 23:00

はじめに

以前、HeadlessCMSのContentfulというWebサービスを使って簡単にブログを作成する方法について説明しました。今回は、日本製のHeadlessCMSであるmicroCMSを使って簡単にブログを作成する方法について説明します。

Contentfulを使って簡単にブログを作成する方法や、「そもそもHeadlessCMSって何?」という方は以下の記事を参照してください。

microCMSについて

microCMSは日本製のHeadlessCMSです。microCMSの一番の強みは言語が日本語だということでしょう。比較対象として挙げられるContentfulはフリープランでは英語かドイツ語しか選ぶことができません。

言語が日本語ということは、Webアプリの使用者が英語に慣れていないという場合にアドバンテージになります。使用者=開発者なら英語でもあまり気にしないかも知れませんが、クライアントからの依頼でHeadlessCMSを使ったブログ機能付きのWebアプリを作成するというときにmicroCMSは選択肢のひとつになり得るでしょう。

RailsでmicroCMSを使う

microCMSの準備

microCMSの登録、基本的な使い方は割愛します。

記事の作成

microCMSで適当な記事を作成しておきます。今回は以下のような記事を作成しました。

API-KEYの取得

左のメニューから歯車アイコンをクリックし、「API-KEY」をクリックします。

「表示」ボタンをクリックし、「X-API-KEY」をコピーしておきます。

エンドポイントの取得

左のメニューから作成したAPI名をクリックし、「API設定」をクリックします。

表示された「エンドポイント」をコピーしておきます。

ルーティングの設定

今回は記事を作成/編集/削除するルーティングは必要ないので、記事の一覧と詳細を表示するルーティングのみを追加します。config/routes.rbに以下を追記します。

routes.rb

Rails.application.routes.draw do
  # 以下を追記
  resources :articles, only: [:index, :show]
end

コントローラーの設定

microCMSに接続するためのGemはないので、コントローラー内でHTTPClientを使ってAPIへのリクエストを作成します。Gemfileに以下を追記してbundle installを実行します。

Gemfile

gem 'httpclient'

以下のコマンドを実行して、記事のコントローラーを作成します。

$ rails generate controller Articles index show

作成したコントローラーに以下を追記します。API名(your-api-name)はご自分のものに変更してください。

articles_controller.rb

class ArticlesController < ApplicationController
  require "httpclient"

  def index
    @articles = microcms
  end

  def show
    @article = microcms(params[:id])
  end

  private
    def microcms(id=nil)
      client = HTTPClient.new
      response = client.get(
        "https://your-api-name.microcms.io/api/v1/articles/#{id}",
        header: { "X-API-KEY": Rails.application.credentials.microcms[:api_key] }
      )

      raise ActiveRecord::RecordNotFound if response.status == 404
      raise Exception unless response.status == 200

      JSON.parse(response.body, symbolize_names: true)
    end
end

APIリクエストのステータスコードが404の場合ActiveRecord::RecordNotFound例外を発生させ、200以外の場合Exception例外を発生させています。ステータスコードが200の場合のみ、レスポンス内容をJSON形式に変換し呼び出し元に返却します。

API-KEYは機密情報なのでCredentialsに登録します。以下のコマンドを実行して、Credentialsを起動します。

$ EDITOR=vi rails credentials:edit

microCMSのAPI-KEYを以下のように設定します。テストサーバーを起動している場合は再起動してください。

microcms:
  api_key: "********-****-****-****-************"

ビューの設定

記事の一覧ページarticles/index.html.erbを作成し、以下を記述します。

index.html.erb

<h1>記事一覧</h1>
<ul>
  <% @articles[:contents].each do |article| %>
    <li><%= link_to article[:title], article_path(article[:id]) %></li>
  <% end %>
</ul>

Slimの場合は以下の通りです。

index.html.slim

h1 記事一覧
ul
  - @articles[:contents].each do |article|
    li
      = link_to article[:title], article_path(article[:id])

記事の詳細ページarticles/show.html.erbを作成し、以下を記述します。

show.html.erb

<h2><%= @article[:title] %></h2>
<%= @article[:content].html_safe %>

Slimの場合は以下の通りです。

show.html.slim

h2 = @article[:title]
= @article[:content].html_safe

動作確認

テストサーバーを起動していない場合は起動し、http://localhost:3000/articlesにアクセスします。

リンクをクリックすると記事の詳細ページに遷移します。

microCMSで記事の修正や追加をしてからRailsアプリを更新してみてください。microCMSで行った変更がRailsアプリで即時反映されることを確認できるかと思います。

まとめ

microCMSの使い方はContentfulとほとんど変わりません。ContentfulではなくあえてmicroCMSを使う理由としては、管理画面が日本語だということに尽きるでしょう。管理画面が日本語であればどんなクライアントにでも安心して使ってもらえるかと思います。

本記事を参考にして、Rails + microCMSでブログを作成していただければと思います。

関連記事

【Rails】ダウンロードしたフリーフォントをWebpackerを使って導入する方法
# はじめに Webサイトのデザインを彩るひとつの要素にフォントの種類があります。Google Fontsの登場により、様々なフォントが手軽に導入できるようになりました。しかし、世の中にはGoogle Fontsが提供するフォント以外にもたくさん [...]
2021年10月16日 13:26
【Rails】mimemagicに依存しているRailsアプリでbundle installコマンドが失敗する事象の対処法
# はじめに Railsアプリで`bundle install`コマンドを実行しようとしたところ、以下のエラーメッセージが出力されコマンドに失敗しました。 ``` Your bundle is locked to mimemagic (0 [...]
2021年10月14日 14:44
【Rails】macOSのアップデート後にrailsコマンドが失敗する事象の対処法
# はじめに 久しぶりにRailsアプリに手を入れようと思い、`rails server`コマンドを実行してRailsサーバーを立ち上げようとしたところ、エラーが出て起動に失敗してしまいました。 前回までの間にしたことの中で思い当たることと [...]
2021年10月14日 12:11
【Rails】Railsアプリのデバッグ《マルチデバイス篇》
# はじめに 近年のWebアプリはレスポンシブ対応が当たり前になっています。最低でもPCとスマートフォンに対応したデザイン、ときにはその中間のタブレットに対応したデザインなんかも作成する必要があります。 Webアプリの開発はPCを使って行う [...]
2021年5月23日 13:02
【Rails】Railsアプリのデバッグ《Better Errors篇》
# はじめに Railsアプリの開発中になんらかのエラーが発生すると、デフォルトでは以下のような画面が表示されます(画像をクリックすると拡大します)。 <a class="gallery" data-group="gallery" href [...]
2021年5月22日 19:42