ドキュメント検索

Algolia を Apidog に連携し、API ドキュメントの検索体験を強化する方法をご紹介します。

既定で公開された API ドキュメントには、名称やパスで API や文書を横断的に探せる内蔵検索が搭載されています。

さらに、Algolia と連携することで検索精度や表現力を高められます。利用には機能の有効化と所定の設定が必要です。

Apidog の対応バージョンは「v2.6.31」以降です。

ドキュメント公開後、サイドバーの ドキュメントサイト タブ内にある ドキュメント検索 へ移動し、編集をクリックして Algolia の接続情報を入力します。

Algolia と Apidog の連携

Algoliaのウェブサイトにアクセスし、アカウントを作成します。

登録後、Algolia にログインします。

ダッシュボードにログインしたら、新規アプリケーションを作成します。

「Upload a File」をクリックしてデータをアップロードします。

TIP

初期設定を素早く行いたい場合は、提供されるサンプルコードで JSON ファイルを生成し、Algolia にドラッグ＆ドロップするだけで構いません。JSON ファイル名がそのまま「Index Name」になり、後で Apidog のドキュメント検索設定で使用します。

検索結果の表示を設計します。

「Continue」を押しながら最終 Step まで進みます。

最後に検索フロントエンドの実装方法を尋ねられますが、ここはスキップして問題ありません。

Algolia の Settings → API Keys ページに移動し、該当アプリケーションの接続情報を取得します。

「Index Name」はここに表示されます。

取得した値を Apidog のドキュメント検索設定にコピーして入力します。

Apidog 側の必須項目を入力後、保存して強化検索を有効化します。

TIP

Algolia は無料で利用できますが、使用量には上限があります。上限拡大には有料プランへのアップグレード、または無料の Algolia DocSearch プランの申請が可能です。

無料枠を超過すると、Apidog 上に以下の通知が表示されます。

Ask AI は、ドキュメント検索の画面内で対話的な AI による Q&A を提供する機能です。ドキュメント検索 設定で「assistant_id」を紐付けると有効化できます。

Algolia には、ドキュメント検索など特定用途向けの無料 DocSearch プランがあります。申請はこちらから行えます。申請フォームの「Documentation URL」欄には、Apidog で公開した API ドキュメントの URL を入力してください。

申請が承認されると確認メールが届き、Algolia ダッシュボードに参加招待が表示されます。案内に従ってアプリケーションへの参加を承認してください。

承認後は、上記と同様の手順で設定情報を取得し、Apidog のプロジェクトに紐付けてください。