Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. はじめに
  • 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紹介

開発チームは、APIの設計、管理、テストを行うために、PostmanやSwaggerなどの複数のツールを使用することに苦労しています。このような断片的なアプローチは、データ同期の問題を引き起こし、協力を妨げ、最終的には効率に悪影響を与えます。
より良い方法を想像してみてください:チーム全体のための単一で統一されたAPIプラットフォーム。明確に定義されたAPI仕様を通じて、バックエンド開発者はAPIをシームレスに実装・テストし、フロントエンド開発者は簡単にAPIを呼び出してモックデータを活用し、テストエンジニアは迅速にテストを実行し、テストケースを生成できます。この効率的なアプローチは、協力を促進し、生産性を向上させます。
Apidogが登場する理由
Apidogは、APIの設計、開発、テスト、管理、ドキュメンテーション、モック機能のために特別に設計された包括的なコラボレーションプラットフォームです。

Apidogがワークフローを統一する方法#

Apidogは、チームが効果的に協力できる中央ハブとして機能します。すべてのチームメンバーは、API仕様を中心に、各自のニーズに対応するためにプラットフォームを活用できます。
Apidogがどのように異なる役割を支援するかは以下の通りです:
APIデザイナー::API仕様を視覚的に作成したり、既存の仕様をインポートしたりできます。また、反復的な設計のためにブランチ管理もサポートします。
バックエンド開発者: API仕様に基づいてリクエストを生成し送信し、ビジネスロジックコードを簡単に作成できます。
フロントエンド開発者: API仕様から自動的にモックデータを生成し、並行開発をサポートします。
QAエンジニア: リクエストを生成・更新し、視覚的にテストシナリオを構築し、CI/CDパイプラインを設定できます。
APIメンテナー: 簡単に明確でインタラクティブなAPIドキュメントを作成できます。
パフォーマンステスター: Apidogは強力なパフォーマンステスト機能もサポートしています。
Apidogでコラボレーション
この統合されたワークフローが提供するもの:
1.
シームレスな協力: 異なる役割が効率的に協力し、APIの継続的な改善を促進します。
2.
整理されたAPI管理: 乱雑なツールを置き換え、中央集権的で整理されたシステムを導入します。
3.
開発者体験の向上: 設計が優れ、文書化されたAPIはコードの再利用を促進し、新しい開発者の学習曲線を減少させます。
Postmanなどのツールと比較して、ApidogはAPI設計および開発チーム専用に特化したコラボレーションプラットフォームとして、その優れた点が際立っています。

Apidog: 豊富な機能と強力な性能#

Apidogは、他にはない豊富な機能を提供します:
1.
API仕様に基づくリクエストパラメータ/ボディの生成
ApidogはAPI仕様に基づいてリクエストパラメータとリクエストボディを自動生成し、時間を節約し、エラーを減らします。
2.
自動応答検証
このツールは、APIの応答を定義された仕様と照合して自動的に検証し、不一致を発見し、一貫性を確保します。
3.
視覚的なアサーションと変数抽出
Apidogは、テストケース作成を簡素化するために、API応答から変数を抽出し、アサーションを作成するためのユーザーフレンドリーなインターフェースを提供します。
4.
Postmanスクリプトとの完全な互換性
ApidogはPostmanスクリプトと完全に互換性があり、チームは既存の知識を活用しながら、Apidogの追加機能を活用できます。
5.
APIデバッグにおけるデータベース接続とCRUD操作
Apidogは、APIデバッグ中にCRUD操作を実行するための直接的なデータベース接続を提供し、テストプロセスを効率化します。
6.
APIケースとしてリクエストを保存
ユーザーは、APIリクエストを簡単にAPIケースとして保存し、包括的なテストスイートを作成し、頻繁に使用するリクエストに迅速にアクセスできます。
7.
外部プログラミング言語との統合
Apidogは他のプログラミング言語との統合をサポートし、チームはAPI開発のワークフローをカスタマイズできます。
8.
マイクロサービスアーキテクチャに完全対応
このツールはマイクロサービスアーキテクチャに対応しており、分散システムのニーズに応えます。
9.
API仕様に基づく自動モックデータ生成
ApidogはAPI仕様に基づいてモックデータを生成し、フロントエンド開発者が独立して作業できるようにし、開発を加速させます。
10.
APIリクエストをAPI仕様に変換するインテリジェントな解析
ApidogはAPIリクエストを解析し、それをAPI仕様に変換することができ、ドキュメント作成を簡単にします。
11.
リクエストシーケンスの視覚的編成
Apidogは、リクエストを順番に並べるための視覚的なインターフェースを提供し、複雑なテストシナリオの作成を簡単にします。
12.
テストケースとモックサービスのためのセルフホステッドランナー
ユーザーは自分のサーバーにApidogランナーをデプロイし、好ましい環境でテストケースを実行したり、モックサービスを作成したりできます。
これらの機能により、ApidogはAPI開発、テスト、管理のための強力で多用途なツールです。APIライフサイクルのさまざまな側面を効率化することによって、ApidogはチームがAPIプロジェクトをより効果的に進める手助けをします。
Previous
Apidog学習センター
Next
概要
Built with