Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. APIドキュメント公開
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. APIドキュメント公開

ドキュメント検索

ApidogとAlgoliaを統合して、APIドキュメントの検索機能を強化する方法を紹介します。
デフォルトでは、公開されたAPIドキュメントには、ユーザーがAPIやドキュメントを名前やパスで検索できる組み込みの検索機能が含まれています。
search-bar-api-documentation.png
さらに、ApidogはAlgoliaとの統合を提供しており、検索機能を強化できます。この機能を利用するには、有効にして必要な設定を完了する必要があります。Apidogのバージョンが2.6.31以上であることに注意してください。
algolia-search-integration.png
integrating-algolia-search-apidog.png
TIP
Algoliaは無料で利用できますが、一定の制限があります。これらの制限を引き上げるには、Algoliaの有料版にアップグレードするか、無料のAlgolia DocSearchプランに申し込むことができます。

ApidogとAlgoliaの統合#

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

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

1.
Algoliaのウェブサイトにアクセスし、アカウントを作成します。
2.
登録後、Algoliaアカウントにログインします。
algoria-website.png

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

1.
ログイン後、Algoliaダッシュボードで新しいアプリケーションを作成します。
2.
Upload a Fileをクリックしてデータをアップロードします。
uploading-files-algolia.png
TIP
初心者が簡単に設定できるように、提供されているサンプルコードを使用してJSONファイルを生成できます。JSONファイルをAlgoliaにドラッグ&ドロップするだけです。JSONファイルの名前がIndex Nameとなり、後でApidogのドキュメント検索設定で必要になります。
upload-records-algolia.png
3.
検索表示をデザインします。
designing-search-display-algolia.png
4.
Nextをクリックして、最終ステップに進みます。
order-results-setting-algolia.png
5.
最終ステップでは、検索フロントエンドをどのように構築するかを尋ねられます。このオプションはスキップできます。
finish-algolia-settings.png

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

1.
Algoliaダッシュボードで、アプリケーションの設定詳細を確認します。
finding-algolia-api-keys.png
Index Nameはここに表示されます:
finding-algolia-index-name.png
2.
これらの設定詳細をコピーして、Apidogのドキュメント検索設定に記入します。

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

Apidogに必要な設定詳細を記入した後、設定を保存して強化された検索機能を有効にします。
integrating-algolia-with-apidog.png
TIP
Algoliaは無料で利用できますが、使用には制限があります。制限を引き上げるには、有料プランにアップグレードするか、無料のAlgolia DocSearchプランに申し込むことができます。
無料プランの制限に達すると、Apidogに通知が表示されます:
algolia-limits.png

無料のAlgolia DocSearchプラン#

Algoliaは、特定の目的(ドキュメント検索など)のために無料のDocSearchプランを提供しています。無料のAlgolia DocSearchプランにここから申し込むことができます。申し込みフォームのDocumentation URLフィールドには、Apidogの公開APIドキュメントURLを入力できます。
申し込みが成功すると、Algoliaから確認メールが送信され、Algoliaダッシュボードにアプリケーションに参加するためのメッセージが表示されます。確認をクリックして、Algoliaが提供するアプリケーションに参加します。
applying-algolia-free-plan.png
確認後、ダッシュボードの左上隅でアプリケーションに切り替え、Application IDとSearch API Keyをコピーして、Apidogの対応するフィールドに記入します。Write API Keyは別の場所で見つける必要があることに注意してください。
image.png
Write API Keyを見つけるには、以下の手順に従ってください:
get-algolia-api-key-step-1.png
get-algolia-api-key-step-2.png
ここにあるAlgolia API Keyを、Apidogの設定項目のWrite API Keyに構成する必要があります。
get-algolia-api-key-step-3.png
同様に、Index Nameの値はここで見つけることができます:
finding-algolia-free-plan-index-name.png
Previous
カスタムレイアウト
Next
カスタムドメイン
Built with