Getting Started

こちらのドキュメントでは、microCMSをRubyアプリケーションから利用するための最短手順を示します。
初めてRubyアプリケーションからmicroCMSをご利用される場合にはまずはこちらの手順をお試しください。

事前に確認が必要なこと

• microCMSのアカウント登録やサービス作成、API作成の仕方を理解している必要があります。操作マニュアルなどをご確認ください。

microCMSのセットアップ

まずはmicroCMSで非常に単純なAPIを作成します。

• オブジェクト形式
• テキストフィールド１つ

設定例を以下に示していきます。APIの作成の詳細手順についてはAPIの作成もご参照ください。

APIの作成画面で適当なAPI名とエンドポイントを入力します。



次にオブジェクト形式を選択します。



最後にフィールドを設定します。今回はテキストフィールドを一つのみ設定します。



上記設定でAPIを作成すると非常にシンプルな入稿画面ができあがるため値を入稿して公開します。



以下のようなcurlコマンドでJSONを取得できることも確認しておきましょう。（ターミナル等を開かなくても、上記画面内の「APIプレビュー」で即座に確認可能です）

curl "https://YOUR_SERVICE.microcms.io/api/v1/YOUR_ENDPOINT" -H "X-MICROCMS-API-KEY: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

Rubyでデータを取得する

最初にRubyでデータを取得する場合の方法です。ご自身の環境に、microcms-ruby-sdk をインストールしましょう。

$ bundle init
$ bundle add microcms-ruby-sdk

そして、main.rb を作成してデータを取得します。service-domainとapi-keyはご自身が設定したものを設定してください。

require 'microcms'

MicroCMS.service_domain = 'service-domain'
MicroCMS.api_key = 'api-key'

puts MicroCMS.list('hello')

ローカルの main.rb を実行してみましょう。microCMSに入稿した内容を取得できます。

$ bundle exec ruby main.rb