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の主要な概念について説明する。他の類似製品(Postmanなど)とは異なる概念が多いため、これらの定義と違いを理解することで、Apidogのワークフローをより深く理解できる。

設計優先 & リクエスト優先#

ApidogのAPI管理モジュールには、インターフェースの左下隅で切り替え可能な2つのモードがあります:「設計優先」と「リクエスト優先」です。
どちらのモードも似たような機能を提供しますが、インターフェースが異なり、異なるチームのワークフローに対応しています。
設計優先は、Apidogが推奨するモードで、設計優先アプローチを採用するチームに適しています。このモードでは、チームはまずAPIの仕様を決定し、その後、API仕様に基づいて開発とテストを進めます。
一方、リクエスト優先は、最初にAPI仕様を定義しないチームに最適です。これらのチームは通常、バックエンド開発に集中し、コードを完成させた後にAPI仕様を作成し、テストやクライアント側の作業を開始します。
他の人が開発したAPIを呼び出す必要があるが、ドキュメントがない場合も、リクエスト優先モードを使用するべきです。
設計優先モード & リクエスト優先モードについてもっと学ぶ。

API#

Apidogは API ファーストの製品で、すべては API の定義から始まる。API の中で最も重要な要素が API だ。
Apidogのメイン画面では、API がディレクトリ形式でグループ化された基本要素として表示される。各 API に対して、「定義の編集」、プレビュー、API 仕様に基づくリクエストの送信、そしてリクエストを API ケースとして保存することができる。
この構造は Postman とは大きく異なり、OAS(API 仕様)をベースに拡張した形に近い。つまり、デバッグやリクエストの保存が直接できる API 仕様という考え方だ。
Postmanでは、基本要素はリクエストで、リクエストは API 仕様とは本質的に切り離されている。そのため、API 仕様が変更されると、すべてのリクエストとスクリプトを書き直す必要がある。
一方、Apidogでは、すべての API ケース(Postmanでいうリクエスト)は API 仕様に基づいている。API 仕様が変更されると、API ケースも自然に変更され、それに基づくすべてのテストシナリオや CI/CD も自動または手動で更新できる。これは開発チームが API を管理・更新する上で非常に便利な仕組みだ。

Request#

Apidogでは、単独のリクエストを作成することもできる。これらのリクエストは API 仕様に基づく必要はなく、Postmanのリクエストと同じ定義方法だ。成功したリクエストを API 仕様として解析することも可能。

テストシナリオ#

複数のリクエストをまとめて送信する必要がある場合(Postman Collectionの実行に相当)、テストシナリオを使用する。
テストシナリオには一連のリクエストが含まれる。これらのリクエストは API 仕様や API ケースからテストシナリオにインポートでき、API 仕様の変更に応じて自動または手動で更新できる。
テストシナリオはIf、for、forEachなどのロジックコンポーネントもサポートしている。リクエスト間でのデータの受け渡しや、リクエストパラメータの動的生成なども可能だ。
テストシナリオをベースに、テストレポートの確認、性能テストの実行、テストデータの管理、CI/CDの統合なども行える。

環境#

Apidogの環境 は、Postmanの環境と同様に、多くの変数を含んでいる。環境を切り替えることで、同じ環境変数の異なる値を使用できる。
ただし、Apidogの環境には、サービスというもう一つの重要な概念がある。各サービスは接頭辞URLに対応している。OASで定義された API はすべて / で始まるため、異なるサービスに送信できる。Apidogでは、リクエストの先頭に {{Base_url}} を書いて、サービスを変数の形で保存する必要はない。対応する環境に切り替えるだけで、すべてのリクエストがその環境の対応するサービスに直接送信される。

プロジェクト#

API、リクエスト、Schema、環境、テストシナリオなどの集まりがプロジェクトを形成する。Apidogでは、プロジェクトが共同作業の基本単位となる。
プロジェクトは一つのOAS定義に対応する。OASをプロジェクトとしてインポート したり、プロジェクトからOASをエクスポートしたりすることも可能だ。Postmanと比較すると、ApidogのプロジェクトはPostman Collectionに、ApidogのチームはPostman Workspaceにおおよそ対応している。
Previous
Apidog操作方法
Next
概要
Built with