Discourse API ruby gemを使う

Discourse APIを利用したいのですね?素晴らしい!始めましょう。

Discourse 開発環境のセットアップ

WindowsmacOS、または Ubuntu のガイドを使用して、Discourse 開発環境をセットアップしてください。

Discourse API Gem のクローン作成

Discourse 開発環境のセットアップが完了したなら、システムにはすでに Git と Ruby がインストールされているはずです。コンソールから次のコマンドを実行して、Discourse API gem をインストールできます。

git clone https://github.com/discourse/discourse_api.git ~/discourse_api

あるいは、gem を直接インストールすることもできます。

gem install discourse_api

依存関係のインストール

discourse_api ディレクトリを開き、次のように入力します。

bundle install

これにより、必要な gem の依存関係がすべてインストールされます。

API キーの生成

Discourse API と対話するために、/admin/api/keys にアクセスして、Discourse インスタンスの API キーを生成します。

API 認証情報の提供

Discourse API gem をクローンし、API キーを生成したので、それを使用してみましょう!

discourse_api/examples/example.rb ファイルを開き、次の情報を変更します。

client = DiscourseApi::Client.new("http://localhost:3000")
client.api_key = "YOUR_API_KEY"
client.api_username = "YOUR_USERNAME"

http://localhost:3000 を、お使いの Discourse インスタンスの URL(例: http://discourse.example.com)に置き換えます。

YOUR_API_KEY を、お使いの Discourse インスタンスの API キー(例: b1f3175cb682b3e9b6ca419db77772120b19af993cbc14ebed80fea08e3bbd66)に置き換えます。

YOUR_USERNAME を、お使いの Discourse インスタンスの管理者ユーザー名(例: codinghorror)に置き換えます。

Discourse API へのアクセス

これで、コンソールで discourse_api ディレクトリから次のように実行します。

ruby examples/example.rb

このコマンドは、Discourse インスタンスから最新のトピックを出力します。

これで完了です。Discourse API を今日から使い始めましょう。


追加リソース:
Discourse API ドキュメント


最終確認者: @SaraDev、[2022-07-12 18:00:00 (America/Los_Angeles) ]

「いいね!」 29