Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
はじめに
Copy Page
Apidog学習センター
はじめに
Apidog紹介
Apidogのナビゲーション
Apidogの基本概念
Apidog基本操作
概要
新しい APIを作成
APIにリクエストを送信
アサーションを追加
テストシナリオを作成
APIドキュメントを共有
さらなる探究
リクエストの送信とAPI保存
Apidogへの移行
概要
手動インポート
定期インポート(データソース連携)
インポートオプション
データのエクスポート
Import from...
Postman からインポート
OpenAPI(Swagger)仕様のインポート
cURLのインポート
Markdownのインポート
Insomniaからのインポート
apiDocからのインポート
.harファイルのインポート
WSDLのインポート
API設計
概要
APIの構成方法
エンドポイントの基本
API設計規範
モジュール
複数のリクエストボディ例の設定
コンポーネント
常用フィールド
グローバルパラメータ
API変更履歴
コメント機能
一括API管理
カスタムプロトコルAPI
データモデル
概要
新規Schemaの作成
JSONなどからのSchema生成
スキーマを構築する
oneOf / allOf / anyOfの使い方
識別器(Discriminator)の利用方法
Security schemes
概要
Security Schemeの作成
Security Schemeの使用
オンラインドキュメントにおけるSecurity Scheme
高度な機能
関連テストシナリオ
パラメータリストの表示形式
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ケースからのデータ同期
フロー制御条件
テストシナリオのエクスポート
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を編集
API適合性チェック
AI命名
よくある質問
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スタートアップガイド
チーム管理
チーム管理
チームメンバーの管理
メンバーの役割と権限設定
チーム活動
チームリソース
汎用ランナー
チーム変数
リクエストプロキシエージェント
リアルタイムコラボレーション
チームコラボレーション
プロジェクト管理
プロジェクト管理
プロジェクトメンバーの管理
通知設定
プロジェクトリソース
Git接続
データベース接続
組織管理
組織管理
シングルサインオン(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 Schema
CSVファイルフォーマット
Java環境のインストール
ランナーのデプロイ環境
ApidogフレーバーMarkdown
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
はじめに
Copy Page
Apidog紹介
Apidogは、APIの設計・開発からテスト、ドキュメント作成、運用管理まで、APIライフサイクル全体を効率化する包括的なプラットフォームです。チームが一元的に協働できる基盤を提供し、すべての工程で一貫性と生産性を高めます。
今すぐ始める
#
無料トライアルを開始
今すぐサインアップ
APIチームのための統合ワークフロー
#
Apidogは、明確に定義された単一のAPI仕様を中心に業務を集約します。各メンバーが役割を果たしながら足並みをそろえ、無理なくコラボレーションできる体制を実現します。
Apidogが各ロールを支援する方法は次のとおりです。
API設計
:ビジュアルにAPI仕様を作成・洗練し、バージョン管理と反復的な改善に対応します。
API設計チュートリアルを見る
バックエンド開発者
:仕様に基づいて実装し、徹底したテストを実施します。
バックエンド実装チュートリアルを見る
フロントエンド開発者
:生成されたMockデータを活用し、バックエンドと並行してUIを開発します。
フロント連携チュートリアルを見る
QAエンジニア
:テストシナリオを構築・実行し、CI/CDと連携して検証を自動化します。
テスト/QAチュートリアルを見る
APIメンテナー
:インタラクティブなドキュメントを容易に生成します。
ドキュメント作成チュートリアルを見る
パフォーマンステスター
:堅牢な性能テストでAPIの信頼性を確保します。
性能テストチュートリアルを見る
この統合アプローチにより、次の価値を提供します。
1.
シームレスな協働:チーム全体で一体となり、API品質の継続的な向上を後押しします。
2.
体系的な管理:API関連業務を、構造化された使いやすい仕組みに集約します。
3.
開発者体験の向上:充実したドキュメントにより再利用性が高まり、新規メンバーのスムーズなオンボーディングを実現します。
Apidogの主な機能
#
Apidogは、API開発基盤として強力かつ実用的な機能群を提供します。以下のカテゴリ別にご確認ください。
設計・開発
#
1.
API仕様に基づくリクエストパラメータ/ボディの自動生成
:API仕様からリクエストの構成要素を自動生成します。
2.
API仕様に基づくMockデータの自動生成
:API仕様に沿って現実的なMockデータを生成します。
3.
APIリクエストの知的解析によるAPI仕様への自動変換
:APIリクエストを解析し、構造化された仕様へ自動反映します。
テストと検証
#
4.
レスポンスの自動検証
:API仕様に照らしてレスポンスを自動的に検証します。
5.
ビジュアルなアサーション作成と変数抽出
:直感的なUIでアサーションと変数抽出を設定できます。前/後処理に対応します。
6.
リクエストをAPIケースとして保存
:APIリクエストを再利用可能なAPIケースとして保存します。
7.
リクエストシーケンスのビジュアルオーケストレーション
:リクエストを視覚的に並べ、流れを設計できます。
コラボレーションと運用管理