ドキュメント検索

ApidogとAlgoliaを統合して、APIドキュメントの検索機能を強化する方法を紹介します。

デフォルトでは、公開されたAPIドキュメントには、ユーザーがAPIやドキュメントを名前やパスで検索できる組み込みの検索機能が含まれています。

さらに、ApidogはAlgoliaとの統合を提供しており、検索機能を強化できます。この機能を利用するには、有効にして必要な設定を完了する必要があります。Apidogのバージョンが2.6.31以上であることに注意してください。

TIP

Algoliaは無料で利用できますが、一定の制限があります。これらの制限を引き上げるには、Algoliaの有料版にアップグレードするか、無料のAlgolia DocSearchプランに申し込むことができます。

ApidogとAlgoliaの統合

ApidogとAlgoliaを統合することで、APIドキュメントの検索機能が強化されます。以下の手順に従って設定を行ってください。

Step 1: Algoliaアカウントの作成

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

登録後、Algoliaアカウントにログインします。

Step 2: Algoliaアプリケーションの作成

ログイン後、Algoliaダッシュボードで新しいアプリケーションを作成します。

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

TIP

初心者が簡単に設定できるように、提供されているサンプルコードを使用してJSONファイルを生成できます。JSONファイルをAlgoliaにドラッグ＆ドロップするだけです。JSONファイルの名前がIndex Nameとなり、後でApidogのドキュメント検索設定で必要になります。

検索表示をデザインします。

Nextをクリックして、最終ステップに進みます。

最終ステップでは、検索フロントエンドをどのように構築するかを尋ねられます。このオプションはスキップできます。

Step 3: ApidogにAlgolia設定を構成

Algoliaダッシュボードで、アプリケーションの設定詳細を確認します。

Index Nameはここに表示されます：

これらの設定詳細をコピーして、Apidogのドキュメント検索設定に記入します。

Step 4: 設定を保存して機能を有効化

Apidogに必要な設定詳細を記入した後、設定を保存して強化された検索機能を有効にします。

TIP

Algoliaは無料で利用できますが、使用には制限があります。制限を引き上げるには、有料プランにアップグレードするか、無料のAlgolia DocSearchプランに申し込むことができます。

無料プランの制限に達すると、Apidogに通知が表示されます：

無料のAlgolia DocSearchプラン

Algoliaは、特定の目的（ドキュメント検索など）のために無料のDocSearchプランを提供しています。無料のAlgolia DocSearchプランにここから申し込むことができます。申し込みフォームのDocumentation URLフィールドには、Apidogの公開APIドキュメントURLを入力できます。

申し込みが成功すると、Algoliaから確認メールが送信され、Algoliaダッシュボードにアプリケーションに参加するためのメッセージが表示されます。確認をクリックして、Algoliaが提供するアプリケーションに参加します。

確認後、ダッシュボードの左上隅でアプリケーションに切り替え、Application IDとSearch API Keyをコピーして、Apidogの対応するフィールドに記入します。Write API Keyは別の場所で見つける必要があることに注意してください。

Write API Keyを見つけるには、以下の手順に従ってください：

ここにあるAlgolia API Keyを、Apidogの設定項目のWrite API Keyに構成する必要があります。

同様に、Index Nameの値はここで見つけることができます：

ドキュメント検索

ApidogとAlgoliaの統合#

Step 1: Algoliaアカウントの作成#

Step 2: Algoliaアプリケーションの作成#

Step 3: ApidogにAlgolia設定を構成#