Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
API設計
Copy Page
Apidog学習センター
はじめに
Apidog紹介
Apidogのナビゲーション
Apidogの基本概念
Apidog基本操作
概要
新しい APIを作成
APIにリクエストを送信
アサーションを追加
テストシナリオを作成
APIドキュメントを共有
さらなる探究
リクエストの送信とAPI保存
移行
概要
手動インポート
定期インポート
インポートオプション
データのエクスポート
Import from...
Postman からインポート
OpenAPI(Swagger)仕様のインポート
cURLのインポート
Markdownのインポート
Insomniaからのインポート
apiDocからのインポート
.harファイルのインポート
WSDLのインポート
API設計
概要
コンポーネント
常用フィールド
グローバルパラメータ
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
変数の抽出
アサーション
データベース操作
概要
MySQL
MongoDB
Redis
Oracle クライアント
スクリプト利用
概要
前処理スクリプト
後処理スクリプト
Postmanスクリプトリファレンス
共通スクリプト
他のプログラミング言語の呼び出し
JavaScriptライブラリの利用
レスポンスの可視化
スクリプトの例
その他の例
スクリプトを使用したリクエストメッセージの変更
スクリプトでの変数の使用
アサーションスク リプト
動的値モジュール
APIモックデータ
概要
スマートMock
カスタムMock
Mockの優先順位
Mockスクリプト
クラウドMock
セルフホストランナーMock
Mock言語 (ロケール)
自動テスト
概要
テストレポート
テストシナリオ
テストシナリオの作成
他のプロジェクトからAPI/APIケースをインポートする
リクエスト間でデータを渡す
API/APIケースからのデータ同期
フロー制御条件
テストシナリオのエクスポート
テストシナリオ実行
データ駆動型テスト
スケジュールタスク
テストシナリオを一括実行する
他のプロジェクトのAPIの実行環境を管理する
テストシナリオを実行する
APIテスト
統合テスト
回帰テスト
エンドツーエンド(E2E)テスト
パフォーマンステスト
Apidog CLI
概要
Apidog CLIのインストールと実行
Apidog CLI オプション
CI/CD
概要
GitHub Actions連携
Jenkins連携
GitLab連携
Gitコミットをトリガーとした自動テスト実行
APIドキュメント公開
概要
サポート対象API技術
クイック共有
APIドキュメントを表示する
Markdownドキュメント
ドキュメントサイトの公開
カスタムレイアウト
カスタムCSS・JavaScript・HTML
カスタムドメイン
SEO設定
LLM最適化機能
詳細設定
ドキュメント検索
CORS プロキシ
Google AnalyticsとDoc Sitesの連携
フォルダツリー設定
可視性設定
ドキュメントURLに値を埋め込む
APIバージョン
概要
APIバージョンの作成
APIバージョンの公開
APIバージョンごとにAPIの共有
リクエスト送信
概要
GraphQL
gRPC
WebSocket
SSEデバッグ
SOAP/Webサービス
デバッグ用のリクエストプロキシエージェントを使用する
Socket.IO
Webhook
リクエスト作成
リクエストの基本
パラメータとボディ
リクエストヘッダー
リクエスト設定
HTTP/2
リクエスト履歴
認証と認可
概要
CAとクライアント証明書
Apidogがサポートする認可タイプ
Digest Auth
OAuth 1.0
OAuth 2.0
Hawk Authentication
Kerberos
NTLM
Akamai EdgeGrid
レスポンスとクッキー
概要
ApidogのAPIレスポンス
Cookieの作成と送信
リクエストのデバッグ
リクエストをAPIとして保存
ブランチ管理
概要
新しいスプリントブランチの作成
スプリントブランチの管理
ブランチ内でのAPIテスト
ブランチでAPIの設計
スプリントブランチのマージ
AI機能
概要
AI機能の有効化
AIでSchemaを編集
よくある質問
Apidog MCP Server
概要
Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
ベストプラクティス
API署名の取り扱い方法
OAuth 2.0で保護されたAPIにアクセスする方法
Apidog コラボレーションワークフロー
Apidogでの認証状態の管理
ガイド:ChatGPT APIのトークンとコスト計算
オフラインスペース
概要
管理
オンボーディングチェックリスト
基本概念
Apidogスタートアップガイド
チーム管理
チーム管理
チームメンバーの管理
メンバーの役割と権限設定
チーム活動
チームリソース
一般ランナー
チーム変数
リクエストプロキシエージェント
データベース接続
リアルタイムコラボレーション
チームコラボレーション
プロジェクト管理
プロジェクト管理
プロジェクトメンバーの管理
通知設定
組織管理
シングルサインオン(SSO)
概要
Microsoft Entra IDの設定
Okta設定
組織のSSOを設定する
チームへのグループのマッピング
ユーザーアカウントの管理
SCIMプロビジョニング
SCIMプロビジョニング入門
Microsoft Entra ID
Okta
組織リソース
セルフホストランナー
請求情報
概要
プランのアップグレード
クレジット
クレジットカードが使えない?
サブスクリプションの管理
データ & セキュリティ
Apidogのデータはどこに保存され、データセキュリティはどのように確保されていますか?
ユーザーデータはどのように保存されますか?このデータは公開されますか?それともプライベートですか?すべてのデータはクラウドに保存されますか?
リクエストを送信する際、Apidogサーバーを経由しますか?データセキュリティは確保されていますか?
アドオン
API Hub
Apidog IntelliJ IDEA プラグイン
ブラウザ拡張機能
Microsoft Edge
Chrome
リクエストプロキシ
Apidogウェブでのリクエストプロキシ
共有ドキュメントでのリクエストプロキシ
Apidogクライアントでのリクエストプロキシ
アカウント & 設定
アカウント設定
OpenAPIアクセストークンの生成
言語設定
ホットキー
ネットワークプロキシ設定
データバックアップ
Apidogの更新
アカウント削除
試験的な機能
参考資料
Swagger拡張機能
Socket通信:パケットの分断と結合
用語の説明
よくある質 問
API設計優先アプローチ
Apidog OpenAPI/Swagger仕様拡張
JSONPath
XPath
正規表現
JSONスキーマ
CSVファイルフォーマット
Java環境のインストール
ランナーのデプロイ環境
ApidogフレーバーMarkdown
API設計
Copy Page
APIの構成方法
Apidogでは、各プロジェクトは複数の
モジュール
で構成されている。各モジュールは1つのAPI仕様ファイル(一般的にはOpenAPI Specification(OAS)ファイル)を表している。
Apidogアプリで新しいAPIプロジェクトを作成するには、
ホーム
→
マイチーム
→
新規プロジェクト
の順に進む。また、既存のAPI仕様や他のプラットフォームからAPIデータをインポートしてプロジェクトを作成することもできる。
プロジェクトの作成
#
1
メインウィンドウ
右上の「+ 新規プロジェクト」ボタンをクリックする。
2
プロジェクトタイプを選択する。Apidogでは現在、「HTTP」と「gRPC」の2種類に対応している。
HTTP:REST、SOAP、GraphQL、WebSocketなどのAPIに適している。
gRPC:gRPCプロトコルを利用するAPIの場合はこちらを選択。詳しくは
gRPCプロジェクトについて
を参照。
3
プロジェクト名を入力する。
4
(任意)
サンプルを含める
をチェックすると、PetStoreのサンプルデータ付きでプロジェクトを作成できる。
5
(複数ユーザーのチームの場合)プロジェクト作成時に他のメンバーの権限を設定できる。詳細は
メンバー権限の設定
を参照。
6
(任意)
プロジェクト言語
を設定できる。詳しくは
言語設定
を参照。
既存APIのインポート
#
すでにAPI Specificationがある場合は、
チーム
-
プロジェクト
画面から
プロジェクトをインポート
を選択するか、 既存プロジェクト内で大きな「➕」アイコンをクリックして
インポート
を選ぶことで、インポート処理を開始できる。既存のAPIデータをApidogに移行する際に便利だ。
1
「プロジェクトをインポート」をクリックする。
2
インポートしたいデータの種類を選択する。
3
ファイルをアップロードするか、データのURLを貼り付ける(OpenAPI/Swagger形式のみ対応)。
4
Apidogが選択した形式に基づいて内容を自動解析する。インポート前にデータのプレビューが可能。インポートする内容やロジックを設定し、確認後にプロジェクトの作成とインポートを実行する。
5
インポートが完了すると、新しいプロジェクトがすぐに利用可能になる。
インポート手順の詳細については、
インポートガイドライン
を参照。
Modified at
2025-07-21 10:52:09
Previous
API変更履歴
Next
一括API管理