Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Apidog基本知識
  • 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. Apidog基本知識

Apidog操作方法

Apidog のメインインターフェースは、以下の部分に大別できます:
ヘッダー(Header)
サイドバー(Sidebar)
ワークベンチ(Workbench)
ディレクトリツリー(Directory tree)
タブ(Tabs)
環境セレクター(Environment selector)
フッター(Footer)
image.png
このレイアウトは、Apidog プラットフォーム内で API 開発およびテストのさまざまな側面を扱うための構造化された使いやすいインターフェースを提供します。

ヘッダー(Header)#

ヘッダーには以下の主な機能が含まれています:
image.png
ホーム(Home): 個人のホームページに移動し、参加しているチーム(チームメンバー、チームプロジェクト、チームプラン、所属している組織、API ハブなど)を表示します。
プロジェクトタブ(Project Tabs): 各タブはプロジェクトを表します。タブをクリックしてプロジェクト間を切り替えます。プロジェクト名の左にあるボタンをクリックすると、別のウィンドウでプロジェクトが開きます。
アップグレード/プラン(Upgrade/Plan): チームが使用している現在のプラン(Plan)を表示します。
リフレッシュ(Refresh): 現在のプロジェクトのデータを再読み込みします。再読み込み後、現在開いているすべてのコンテンツタブが閉じられます。
設定(Settings): ローカル設定、ここで外観やプロキシなど、現在のクライアントにのみ関係する設定を行います。ログインユーザーには影響しません。
通知(Notifications): チーム活動からのアラートを表示し、注意が必要な事項を知らせます。
アバター(Avatar): アカウント設定、基本的なアカウント情報やアクセストークンなどを設定できます。

サイドバー(Sidebar)#

サイドバーには以下の機能があります:
プロジェクトアイコン: クリックして、チームやプロジェクトに移動します。
API管理: Apidog のコアインターフェースで、ここでは API の定義、デバッグ、リクエスト送信、Schema作成、Markdown の記述などができます。
自働テスト: リクエストをバッチで送信(Postman コレクションの実行に似ている)したり、リクエスト間でデータ関係や送信ロジックをオーケストレーションしたりする必要がある場合、「自働テスト」モジュールでテストシナリオを作成 できます。また、ここではテストレポートの確認、パフォーマンステストの実行、テストデータの管理、CI/CD の統合なども行えます。
共有: API を定義した後、このモジュールで他の同僚と共有 したり、正式に API ドキュメントとして公開することができます。ここで、ドキュメントのインターフェースの定義や、カスタムドメインの設定などもできます。
履歴: 送信されたすべてのリクエストは「履歴」セクションで確認でき、再送信することができます。
設定: 現在のプロジェクトに関連するすべての設定がここにあります。基本設定、機能設定、通知設定、プロジェクトリソース、プロジェクトデータのインポート/エクスポートなどが含まれます。
招待: 他のユーザーを現在のプロジェクトに招待します。

ワークベンチ(Workbench)#

ディレクトリツリー(Directory tree)#

ディレクトリツリーには、以下の機能モジュールが上から下まで含まれています:
ブランチとバージョン: デフォルトはメインブランチで、他のブランチに切り替えたり、新しいブランチを作成したり、ブランチを管理したりできます。
検索とフィルタ: APIを検索およびフィルタリングできます。現在はAPI名のみ検索でき、フォルダ名やケース名は検索できない点に注意してください。
新規作成: API、リクエスト、スキーマ、Markdown などのさまざまな要素を作成できます。
概要: プロジェクトの全体的なビュー。
API: フォルダ構造で整理されたAPIおよびAPIケース。Markdown や Websocket なども混在可能です。
Schemas: フォルダ構造で整理されたスキーマ。
Components: 再利用可能なコンポーネント。現在はレスポンスコンポーネントのみサポートしています。
Requests: フォルダ構造で整理された API リクエスト、Postman のコレクションに似ています。
ゴミ箱: 削除されたAPI、スキーマ、コンポーネント、リクエストなどはゴミ箱に移動され、30日後に自動的に削除されます。

タブ(Tabs)#

ディレクトリツリーのいずれかの要素をクリックすると、タブが開きます。
タブには以下の種類があります:
API
Schema
Component
Markdown
フォルダ
Request
WebSocket
概要
ゴミ箱
新規作成
タブを単一クリックで開くと、タブのタイトルがイタリック体で表示されます。このイタリック体の状態では、ディレクトリツリーの別の要素をクリックすると、古いタブが上書きされます。これは閲覧シナリオに適しています。
タブの内容に変更を加えると、タブのタイトルが通常のフォントに変わります。通常のフォント状態では、別のディレクトリツリーの要素をクリックすると、新しいタブが開きます。これは編集シナリオに適しています。
開いたタブが他のタブに上書きされないようにしたい場合は、ダブルクリックでタブを開くこともできます。これにより、タブが直接通常のフォント状態になります。
タブの右側には2つのボタンがあります:
新規作成: さまざまな種類の要素を作成できます。
その他: すべてのタブを閉じる、現在のタブを閉じる、または現在のタブ以外のすべてのタブを閉じることができます。

フッター(Footer)#

image.png
左から右に、フッターには以下の機能があります:
折りたたむ/展開する: ディレクトリツリーを折りたたむまたは展開できます。
オンライン: オンラインの状態を示します。オフラインの場合、チームの同期に問題が発生する可能性があります。
エージェント: Apidog Web専用の機能で、どのエージェントがApidog Webのリクエストを送信するかを選択できます。
Cookies管理: クッキー管理ツールで、現在のクッキーを保存できます。
コミュニティ: Apidogコミュニティへのリンク、Discord、Slack、Teams、X(旧Twitter)、およびEmailが含まれています。
外観: Apidogの背景色、テーマカラー、フォントサイズを変更できます。
ヘルプとサポート: ヘルプドキュメントを開きます。
Previous
リクエストを送信してAPIとして保存
Next
Apidogの基本概念
Built with