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仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. API開発とデバッグ

ApidogでAPIを開発およびデバッグする

Apidogは、API仕様を活用して、テストと開発プロセスを効率化する包括的なデバッグ機能を提供している。主な機能を紹介する。

リクエストの自動生成機能#

API仕様に基づいて、リクエストパラメータとボディを自動生成し、デバッグの精度と効率を向上させる。
API仕様に基づくリクエスト生成: API仕様に定義されているリクエストパラメータとボディを自動生成し、テストの正確性を高め、時間を節約できる。
動的な値でリアルなデータを生成: 実際のシナリオを想定したデータをリクエストに組み込み、データの変化に対する問題点を特定する。
APIのテストケースとして保存: リクエストの設定をテストケースとして保存し、回帰テストや繰り返しテストを効率的に実行できる。

簡単な自動ビジュアルテスト#

手動設定なしで、APIレスポンスを視覚的にテストできる。
レスポンスの自動検証: API仕様に基づいてレスポンスを自動的に検証し、不一致を検出する。
ビジュアルアサーションテスト: GUIでアサーションを作成でき、コードを書かずにAPIレスポンスの条件を定義できる。
Postmanスクリプトとの完全な互換性: 既存のPostmanスクリプトをApidogに移行し、高度な機能を活用できる。

他にはない独自の機能#

複雑な環境での包括的なAPIテストを可能にする独自のツールを提供している。
データベース連携によるCRUD操作: APIテスト中に直接データベースに接続してCRUD操作を実行できる。
外部プログラミング言語との連携: 外部のプログラミング環境と連携し、カスタマイズされたテスト環境を構築できる。
マイクロサービスアーキテクチャのサポート: マイクロサービスベースのアプリケーションの管理とデバッグを最適化する。

その他の機能#

APIの開発ワークフローを向上させる追加ツールとモードを提供している。
設計/デバッグモード: API仕様の作成とデバッグを切り替えて作業できる。
コード生成: 様々なプログラミング言語でコードスニペットを自動生成する。
リクエストからのAPI仕様自動生成: API仕様が古いか存在しない場合、リクエストからAPI仕様を自動生成できる。
Apidogの包括的なデバッグ機能を活用することで、開発者はAPIテストにかかる時間と労力を大幅に削減でき、堅牢で信頼性が高く、スケーラブルなAPIソリューションを実現できる。

チーム別の活用方法#

API設計優先チームの場合#

API設計が完了したら、バックエンドチームはAPI仕様を使って開発とデバッグを行える。

開発前#

コード生成: API仕様に基づいて、クライアントSDK、サーバースタブ、APIドキュメントを様々な言語で生成できる。

開発後#

APIリクエストの生成と送信: API仕様に基づいてリクエストを生成できる。
動的な値: リクエスト送信時に、定義したルールに基づいて新しい値を生成できる。
環境とサービス: 開発、テスト、本番環境の切り替えが可能。
レスポンスの検証: APIレスポンスがスキーマや条件に一致するか検証できる。
前/後処理: APIリクエストの前後で実行する処理を定義できる。
Script機能: カスタマイズや自動化のためのスクリプトを作成・実行できる。
APIテストケース: 特定のAPIに対するテストケースを定義し、自動テストに組み込める。

コード優先チームの場合#

コード優先の開発アプローチを取るチームのために、以下の機能を提供している:
Apidog IDEAプラグイン: コードからAPI仕様を生成できる。
定期的なインポート: SwaggerからAPI仕様を自動で同期できる。
デバッグモード: デバッグ中にAPI仕様をリアルタイムで修正できる。
動的な値: リクエスト送信時に、定義したルールに基づいて新しい値を生成できる。
環境とサービス: 開発、テスト、本番環境の切り替えが可能。
前/後処理: APIリクエストの前後で実行する処理を定義できる。
Script機能: カスタマイズや自動化のためのスクリプトを作成・実行できる。
APIテストケース: 特定のAPIに対するテストケースを定義し、自動テストに組み込める。
Modified at 2025-04-15 09:23:19
Previous
API固有識別子
Next
リクエストの生成
Built with