microCMS Ruby SDK

microCMS のRuby SDKです。

保守方針

このSDKの現在の保守レベルは Maintenance です。

詳細はSDKの保守方針をご覧ください。

チュートリアル

公式チュートリアルをご覧ください。

インストール

アプリケーションのGemfileに以下を追加します。

gem'microcms-ruby-sdk'

その後、以下を実行します。

$ bundle install

または、以下のコマンドで直接インストールできます。

$ gem install microcms-ruby-sdk

使い方

インポート

require'microcms'

クライアントオブジェクトの作成

MicroCMS.service_domain='YOUR_DOMAIN'MicroCMS.api_key='YOUR_API_KEY'

YOUR_DOMAIN にはサービスのサブドメイン名（XXXX.microcms.io の XXXX の部分）を指定してください。FQDNではありません。

コンテンツ一覧の取得

putsMicroCMS.list('endpoint')

パラメータを指定したコンテンツ一覧の取得

putsMicroCMS.list('endpoint',{draft_key: "abcd",limit: 100,offset: 1,orders: ['updatedAt'],q: 'こんにちは',fields: %w[idtitle],ids: ['foo'],filters: 'publishedAt[greater_than]2021-01-01',depth: 1,},)

単一コンテンツの取得

putsMicroCMS.get('endpoint','ruby')

パラメータを指定した単一コンテンツの取得

putsMicroCMS.get('endpoint','ruby',{draft_key: 'abcdef1234',fields: %w[titlepublishedAt],depth: 1,},)

オブジェクト形式のコンテンツの取得

putsMicroCMS.get('endpoint')

コンテンツの作成

putsMicroCMS.create('endpoint',{text: 'こんにちは、microcms-ruby-sdk！'})

IDを指定したコンテンツの作成

putsMicroCMS.create('endpoint',{id: 'my-content-id',text: 'こんにちは、microcms-ruby-sdk！',},)

下書きコンテンツの作成

putsMicroCMS.create('endpoint',{id: 'my-content-id',text: 'こんにちは、microcms-ruby-sdk！',},{status: 'draft'},)

コンテンツの更新

putsMicroCMS.update('endpoint',{id: 'microcms-ruby-sdk',text: 'こんにちは、microcms-ruby-sdkのupdateメソッド！',},)

オブジェクト形式のコンテンツの更新

putsMicroCMS.update('endpoint',{text: 'こんにちは、microcms-ruby-sdkのupdateメソッド！'})

コンテンツの削除

MicroCMS.delete('endpoint','microcms-ruby-sdk')

開発

リポジトリをチェックアウトした後、bin/setup を実行して依存関係をインストールしてください。bin/console を実行すると、対話形式で動作を確認できます。

このgemをローカル環境にインストールするには、bundle exec rake install を実行してください。新しいバージョンをリリースするには、version.rb のバージョン番号を更新してから bundle exec rake release を実行します。このコマンドはバージョンのgitタグを作成し、gitのコミットとタグをpushした後、.gem ファイルをrubygems.orgにpushします。

コントリビュート

バグ報告やプルリクエストは、GitHubで受け付けています。