自作サービスで輪読会一覧を表示するために、輪読会一覧を返すAPIを実装した

[masyuko0222]

概要

自作サービスである「輪読会ノート」で輪読会一覧を取得する必要があるので、APIを実装しました。

利用方法

自作サービス側での利用時の認証は、test/supports/api_helper.rbのcreate_tokenのようなメソッドを実装し、FBCと同様、自身のアカウントを利用してjwt認証をします。そして認証成功後、APIデータを取得する流れになります。

def create_token(login_name, password)
  post api_session_url, params: { login_name:, password: }
  JSON.parse(body)['token']
end

なお、利用するlogin_nameとpasswordはENVファイルで管理する予定です。

FBCからAPIキーを発行し、自作サービス側でそのAPIキーを利用し...といった実装は、時間がかかりすぎてしまいそうなので上記を採用することにしました。

確認方法

1. サーバを立ち上げる
2. 任意ユーザーでログイン
3. http://localhost:3000/api/reading_circles.jsonにアクセスする。
4. 以下データが返ってきていたらOK

   {"reading_circles":[{"id":927610372,"title":"ダッシュボード表示確認用テスト定期イベント","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":839258526,"title":"独習Git輪読会","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":722419750,"title":"チェリー本輪読会","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":670378901,"title":"Discord通知確認用、祝日非開催イベント(金曜日開催)","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":470315189,"title":"Everyday Rails輪読会","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":284302086,"title":"Discord通知確認用イベント(土曜日 + 日曜日開催)","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":120758905,"title":"Discord通知確認用、祝日非開催イベント(金曜日 + 土曜日開催)","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":83960073,"title":"Ruby超入門輪読会","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"},{"id":5047957,"title":"Discord通知確認用イベント(土曜日開催)","finished":false,"updated_at":"2024-10-22T20:33:49.955+09:00"}]}

[masyuko0222]

@komagata 自作サービスで利用するAPIのPRを作成したので、レビューをお願いしたいです。

[komagata]

@masyuko0222 PRのタイトルを他のPRのようにわかりやすい内容にお願いします〜

[masyuko0222]

@komagata すみません、タイトルを修正いたしました。

[masyuko0222]

@komagata 本番環境での確認が取れました〇