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スタートアップガイド

組織内でApidogを使い始めるには、以下のタスクを進めてApidogチームを成功に導く準備をしましょう。まずは、チーム管理者や組織のITチームと協力して、Apidogの設定、セキュリティ、管理を行うことをお勧めします。その後、関連する設定を構成し、チームにメンバーを招待して役割を割り当て、プロジェクトに関連するリソースを作成することで、Apidogチームをセットアップできます。
Windows、Mac、Linux用のApidogデスクトップアプリをダウンロードしてインストールできます。また、Apidogエージェントを使ってウェブ上でApidogにアクセスすることも可能です。

ITチームとの協力#

新しいソフトウェアを追加する手順を確立するために、ITチームに連絡を取りましょう。手順は組織によって異なりますが、以下のトピックが一般的です:
ITチームは、従業員のワークステーションにApidogをインストールできるようにデバイスポリシーに例外を追加する必要があるかもしれません。ApidogのダウンロードリンクをITチームに提供して、この例外を確立するのを手助けしましょう。
組織のネットワーク接続がプロキシの背後にある場合、Apidogを適切に設定する必要があるかもしれません。ITチームからプロキシ接続の詳細を取得し、Apidog内で設定してください。
すでにApidogにログインしている場合は、Apidogインターフェースの右上にある⚙設定 - プロキシオプションに移動してプロキシを設定できます。まだApidogにログインしていない場合は、Apidogクライアントアプリケーションのログイン画面の左下でプロキシ設定を構成できます。
組織がファイアウォールの背後で運用されている場合、ITチームはApidogのドメインの許可リストを設定する必要があるかもしれません。これにより、Apidogのデータがクラウドと同期され、すべての機能が期待通りに動作します。
Apidogのドメインには以下が含まれます:
*.apidog.com
*.apidog.io

Apidogチームのセットアップ#

まず、組織内で誰がチーム管理者になるかを決める必要があります。チーム管理者はApidogアカウントを登録し、新しいチームを作成し、この新しいチームのチームオーナーになります。
チームオーナーには以下の権限があります:
チーム情報の変更
新しいプロジェクトの作成
メンバーの招待と削除
他のメンバーのチーム権限とプロジェクト権限の設定
サブスクリプションと支払いの管理
チームの移譲と解散
チームは複数のメンバーで構成され、さまざまなプロジェクトを管理できます。管理者は、特定のプロジェクト内でどのメンバーがどの権限を持つかを決定する権限を持っています。
Apidogの無料版では、チームは最大4人のメンバーを持つことができます。チームが4人を超える場合は、Apidogの有料プランにアップグレードする必要があります。

チームメンバーの管理#

チームオーナーは、他のメンバーをチーム管理者として招待し、チーム内で追加の協力メンバーを招待および管理する責任を持たせることができます。
チーム管理者は、メールや招待リンクを通じて他のメンバーを招待してチームに参加させることができます。メンバーを招待する際、チーム内のプロジェクトに関するメンバーのデフォルト権限を設定できます。これらの権限には通常、管理者、編集者、読み取り専用、禁止が含まれます。
Apidogでは、チーム権限とプロジェクト権限は異なる承認レベルであることに注意が必要です。チーム権限は、チーム全体の管理に使用され、チーム設定、メンバー管理、全体的なチームガバナンスを含みます。チーム権限には、チームオーナー、チーム管理者、チームメンバー、ゲストなどの役割が含まれます。
一方、プロジェクト権限は、チーム内の個々のプロジェクトを管理するために特化されています。これらの権限は、プロジェクト設定、アクセス制御、プロジェクト範囲内での協力に関連する側面を管理します。プロジェクト権限には、管理者、編集者、読み取り専用、禁止などの役割が含まれ、特定のプロジェクト内でのチームメンバーの制御とアクセスレベルを決定します。

プロジェクトの作成#

Apidogでは、各プロジェクトがOpenAPI Specificationに対応しています。API仕様に加えて、Apidogプロジェクトにはテストシナリオ、APIドキュメント、この仕様に関連する一連の独立したリクエスト、およびプロジェクト固有のさまざまな設定が含まれています。
Postmanに合わせて、Postman WorkspaceがApidogのチームに対応し、Postman CollectionがApidogのプロジェクトに対応します。
Apidogには、HTTPプロジェクトとgRPCプロジェクトの2種類のプロジェクトがあります。これらのプロジェクトタイプは異なる組織構造を持ち、混在させることはできません。
HTTPプロジェクト:HTTPプロジェクトでは、REST API、SOAP/WebService、GraphQL、WebSocket、Server-Sent Events (SSE)などの一般的なHTTPプロトコルAPIをデバッグできます。HTTPプロジェクトは、HTTP標準に準拠したさまざまなAPIをテストおよび操作するための多用途な環境を提供します。ユーザーは、HTTPプロジェクト設定内で多様なAPIタイプを探索およびデバッグできます。
gRPCプロジェクト:一方、gRPCプロジェクトは、gRPC APIのデバッグ専用に設計されています。
Apidogで新しいプロジェクトを作成する特権は、チームオーナーとチーム管理者のみが持っています。Apidogでプロジェクトを作成する際、管理者はプロジェクトタイプを選択し、このチーム内の他のチームメンバーのデフォルト権限を定義できます。

データ移行#

Apidogは、十数種類以上の異なる形式でデータをインポートすることをサポートしており、さまざまな[一般的なAPI形式]をApidogに簡単にインポートできます。
Postmanからインポートする際、基本的なデータ構造の違いにより、PostmanリクエストはApidogではAPIケースとして認識され、ベースURLはApidogの環境サービスモジュールに保存されます。これは、Apidog内でのPostmanリクエストの通常の機能に影響を与えません。Postmanスクリプトは、Apidog内で直接実行でき、互換性の問題はありません。Postmanからの移行に関する詳細は、Apidog移行ブログを参照してください。
Apidog内のプロジェクトから別のApidogプロジェクトにデータを移行する必要がある場合は、設定メニューの「エクスポート」オプションを使用して、Apidog形式でデータをエクスポートします。その後、このファイルをターゲットプロジェクトにインポートします。Apidog形式は、包括的なプロジェクト情報をカプセル化しています。Apidogプロジェクト間のデータ移行にはOpenAPI形式を使用しないでください。API仕様以外のデータが失われる可能性があります。この方法は、Apidogプロジェクト間のプロジェクトデータの完全かつ正確な転送を保証します。
Apidog Global、Apidog Europe、およびApidogオンプレミスプラットフォーム間のデータは相互運用できず、Apidog形式へのエクスポート方法を使用して移行する必要があります。

初期プロジェクト設定#

将来のチームコラボレーションを円滑にするために、プロジェクトの開始時に以下の設定を構成することをお勧めします。
1.
[プロジェクト言語]:Apidogは「プロジェクト言語」と「インターフェース言語」を区別しています。プロジェクト言語は、プロジェクト内で作成されたコンテンツに使用される言語を指し、インターフェース言語はユーザーインターフェースに表示される言語です。プロジェクトを作成する際には、プロジェクト言語を選択することが重要です。プロジェクト内の一部の初期コンテンツは、この言語で初期化されます。
2.
デフォルトレスポンステンプレート:会社が標準化されたレスポンス構造を持っている場合、それを「デフォルトレスポンステンプレート」として設定できます。これにより、新しく作成されたAPIがこのテンプレートをデフォルトのレスポンスとして持ち、プロジェクト全体で一貫性を保つことができます。
デフォルトレスポンステンプレートは、API - コンポーネント - デフォルトレスポンステンプレートで設定できます。
3.
レスポンスコンポーネント:通常、プロジェクト内のさまざまなAPIのエラーレスポンスは類似しています(例:400、404)。これらの一般的なエラーレスポンスを「レスポンスコンポーネント」として構成し、デフォルトで有効にすることができます。この設定により、新しく作成されたAPIがこれらの事前構成されたレスポンスを持ち、レスポンス処理の効率と一貫性を促進します。
4.
APIステータス:Apidogは、カスタマイズ可能なAPIステータスを提供しており、会社の特定の要件に基づいてこれらを調整できます。これらのステータスを使用して、プロジェクト内の各APIの進捗やステータスを分類および追跡できます。ワークフローやプロジェクト管理の実践に合わせて、どのAPIステータスを有効にし、構成するかを決定できます。
APIステータスは、設定 - 一般設定 - 機能設定 - API機能設定 - APIステータスで設定できます。

統合#

Apidogは、さまざまな一般的なツールとの統合をサポートしており、API構築プロセスを大いに促進します。
1.
CI/CD統合:Apidogはコマンドラインから実行でき、Jenkins、Github、GitlabなどのさまざまなCI/CDツールと統合できます。この統合により、CI/CDパイプライン内でのAPIテストとデプロイメントプロセスのシームレスな自動化が可能になります。
2.
データベース統合:Apidogは、前処理および後処理でのSQLクエリの実行をサポートし、データベーステーブル構造からAPIスキーマを生成する機能を提供します。MySQL、SQL Server、Oracle、MongoDBなど、さまざまなデータベースが統合に対応しており、API開発とデータ管理の柔軟性を向上させます。
3.
通知統合:Apidogは、APIの作成、変更、削除などのアクティビティをSlackやWebhooksをサポートする任意のツールに転送することを可能にします。この通知統合により、API開発活動に関するリアルタイムの更新とコラボレーションがチームやプラットフォーム間で確保されます。
Apidogでは、ワークフローを強化し、プラットフォームの機能を拡張するために、追加の外部ツール統合をさらに探索できます。Apidogの統合機能を活用することで、さまざまな外部ツールやサービスと簡単に接続し、API開発とコラボレーションを効率化できます。

Apidogの機能に慣れる#

Apidogは、プラットフォームの機能を理解するための包括的なドキュメントを提供しています。Apidogを初めて使用する場合は、Apidogの基本機能に慣れるために「Apidogの最初のステップ」ガイドを読むことをお勧めします。
チーム内の異なる役割に応じて、各役割に割り当てられた機能を理解するために対応するセクションを参照できます。
API設計者:APIの設計と公開
バックエンド開発者:APIのデバッグ
フロントエンド開発者: APIのモック
QAエンジニア:APIのテスト
Previous
基本概念
Next
チーム管理
Built with