Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. AI機能
  • 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
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MySQL
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JavaScriptライブラリの利用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモックデータ
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • GitHub Actions連携
      • Jenkins連携
      • GitLab連携
      • Gitコミットをトリガーとした自動テスト実行
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • LLM最適化機能
    • 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の設計
    • スプリントブランチのマージ
  • AI機能
    • 概要
    • AI機能の有効化
    • AIでSchemaを編集
    • よくある質問
  • 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
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • データ & セキュリティ
    • Apidogのデータはどこに保存され、データセキュリティはどのように確保されていますか?
    • ユーザーデータはどのように保存されますか?このデータは公開されますか?それともプライベートですか?すべてのデータはクラウドに保存されますか?
    • リクエストを送信する際、Apidogサーバーを経由しますか?データセキュリティは確保されていますか?
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • OpenAPIアクセストークンの生成
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データバックアップ
    • Apidogの更新
    • アカウント削除
    • 試験的な機能
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. AI機能

AI機能の有効化

ApidogのAI機能はデフォルトで無効になっています。有効にするには、組織/チーム → リソース → AI機能に移動し、スイッチをオンにします。有効化後、組織またはチーム内のすべてのプロジェクトでAIを活用して生産性を向上させることができます。
AI機能の設定は、組織またはチームの管理者(またはそれ以上の権限を持つロール)のみが行えます。

モデルプロバイダーの設定#

AI機能を有効にすると、モデルプロバイダーを設定するオプションが表示されます。+ Add Providerをクリックして設定を開始します。
image.png
現在、Apidogは以下のモデルプロバイダーをサポートしています:
OpenAI
Anthropic
Google Al studio
Google Vertex
img_v3_02nl_16642d0d-72b2-4618-9a38-4eeef7db106g.png
これらのプロバイダーが要件を満たさない場合、カスタムAPI設定を使用して他のプロバイダーモデルに接続することも可能ます。
一般的に、以下の設定をカスタマイズできます:
1.
API Key
選択したモデルプロバイダーから提供されたAPI Keyを入力します。Test機能を使用してキーの有効性を確認できます。
apidog-API-Key-Setup.gif
2.
API Base URL
ApidogでAI機能を使用する際にリクエストが送信される実際のURLです。組み込みプロバイダーの場合、ベースURLは事前に入力されていますが、必要に応じて編集できます。
AIモデルへの各リクエストは、ApidogサーバーからこのAPIベースURLに送信されます。
3.
Model List
AIプロバイダーが提供するモデルのリストです。プリセットプロバイダーを使用している場合、一部のモデルはデフォルトで表示されます。このリストで有効にしたモデルのみがAI機能で使用できます。必要なモデルがリストにない場合は、手動で追加できます。
ApidogのAI機能にはプリセットのプロンプトと呼び出しフローが付属しています。最適な結果を得るためには、高度で強力なモデル(長いコンテキストのサポート、関数呼び出しなどに対応したモデル、例えばGPT-4.1-mini)を選択することをお勧めします。
4.
API Format
カスタムAPI設定では、リクエストとレスポンスのフォーマットを定義できます。誤ったフォーマットを使用するとAPIリクエストが失敗する可能性があります。ほとんどのモデルはOpenAIフォーマットに従っています。

デフォルトモデルの設定#

ユーザーがAI機能を使用する際にモデルを指定しない場合、Apidogはここで設定されたデフォルトモデルを使用します。現在有効なすべてのモデルがドロップダウンに表示されるので、デフォルトとして使用したいモデルを選択します。
image.png
デフォルトモデルは初期状態で「自動選択」に設定されており、有効なプロバイダーとモデルの順序に基づいて利用可能なモデルを自動的に選択します。
特定のモデルをデフォルトに設定した後、そのモデルが無効化または削除された場合、Apidogは自動的に「自動選択」に戻ります。

機能とプロンプト#

ここではすべてのApidog AI機能を管理し、プロンプトをカスタマイズできます。機能を有効にすると、プロジェクトの関連セクションに表示されます。Apidogは各機能にデフォルトのプロンプトを提供しており、ニーズに合わせて調整できます。
image.png
現在、プロンプトのカスタム編集はサポートされていません。今後の更新にご期待ください!

組織からチームへのAI設定の継承#

組織管理を使用している場合、組織の管理者または所有者は組織レベルでAI機能を設定できます。これらの設定は組織内のすべてのチームに適用可能で、一貫性を維持しプロジェクト全体の管理を簡素化するのに役立ちます。
組織管理ページのリソースには、チームレベルと同じAI機能設定インターフェースがあります。
image.png
組織レベルでAI機能を設定すると、組織内のすべてのチームは設定済みのモデルプロバイダー、デフォルトモデル、機能を継承できます。
image.png
組織下のチーム継承に関する要点:
1.
AI機能のスイッチ、モデルプロバイダー設定、デフォルトモデル選択、機能などすべてのトグルは組織の設定に従います:
組織レベルで機能が有効になっている場合、チームはそれをオンまたはオフにできます。
組織レベルで機能が無効になっている場合、チームはそれを有効にできません。
これにより、すべてのチームで集中管理と一貫性が確保されます。
image.png
2.
モデルプロバイダーは、組織から継承するか、各チームが独自に設定するかを選択できます。
image.png
3.
チームは、組織レベルで定義されたデフォルトモデルを使用するか、独自に設定することもできます。
image.png
Modified at 2025-07-01 08:33:22
Previous
概要
Next
AIでSchemaを編集
Built with