Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Home
Learning Center
Support Center
API References
🇯🇵 日 本語
🇺🇸 English
🇯🇵 日本語
管理
オンボーディングチェックリスト
Apidog学習センター
概要
概要
Apidog紹介
API設計者:APIの設計と公開
バックエンド開発者: APIのデバッグ
フロントエンド開発者: APIのモック
QAエンジニア: APIのテスト
リソース
はじめに
Apidog基本操作
概要
ダウンロード & 登録
新しい 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生成
高度な機能
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スクリプト
自動テスト
概要
テストレポート
テストシナリオ
テストシナリオのエクスポート
他のプロジェクトから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の設定
組織のSSOを設定する
チームへのグループのマッピング
ユーザーアカウントの管理
SCIMプロビジョニング
SCIMプロビジョニング入門
Microsoft Entra ID
リソース
セルフホストランナー
請求情報
概要
プランのアップグレード
クレジット
クレジットカードが使えない?
サブスクリプションの管理
アドオン
API Hub
Apidog IntelliJ IDEA プラグイン
リクエストプロキシ
Apidogウェブでのリクエストプロキシ
共有ドキュメントでのリクエストプロキシ
Apidogクライアントでのリクエストプロキシ
ブラウザ拡張機能
Microsoft Edge
Chrome
アカウント & 設定
アカウント設定
言語設定
データバックアップ
ネットワークプロキシ設定
ホットキー
Apidogの更新
OpenAPIアクセストークンの生成
アカウント削除
参考資料
Swagger拡張機能
Socket通信:パケットの分断と結合
用語の説明
よくある質問
API-デザインファース トアプローチ
Apidog OpenAPI仕様拡張
JSONPath
XPath
正規表現
JSONスキーマ
CSVファイルフォーマット
Java環境のインストール
ランナーのデプロイ環境
ApidogフレーバーMarkdown
管理
オンボーディングチェックリスト
基本概念
Apidogは、APIの設計、開発、ドキュメント作成を効率的に組織化、管理、協力するための強力な管理ツールを提供します。「
チーム
」、「
プロジェクト
」、「
組織
」という3つのレベルで作業を整理することで、さまざまな範囲でAPIタスクをより効果的かつ精密に管理・監督できます。
チーム
#
チームは、協力と組織化の中核単位です。各チームは複数のプロジェクトとメンバーを含むことができ、チーム間のデータは独立しており、互いに見えないため、データの隔離が保証されます。
チームの機能には、主にメンバー管理、権限制御、協力が含まれます。チームメンバーを招待してチームに参加させ、異なる役割と権限を割り当てることで 、プロジェクトとデータの安全性を確保できます。チームメンバーはリソースを共有し、共同編集し、アイデアを交換することで、チームの協力効率とプロジェクトワークフローの質を向上させます。
以下のドキュメントを読むことで、チームの機能とその使い方を簡単に把握できます:
チーム管理
チームメンバー管理
プロジェクト
#
プロジェクトは、APIと関連ドキュメントを組織化し管理するための基本単位です。各プロジェクトは独立したワークスペースを表し、APIの作成、編集、テスト、APIドキュメントの設計と管理、チームメンバーとのプロジェクト協力が可能です。
複数のプロジェクトを作成することで、チームの異なるニーズと能力に応じてAPIとドキュメントを分類できます。これにより、さまざまなAPIをより良く組織化・管理し、作業の効率と保守性を向上させることができます。各プロジェクトには独自の設定と権限制御があり、プロジェクトの安全性とデータのプライバシーを確保します。
以下のドキュメントを読むことで、プロジェクトの機能とその使い方を簡単に把握できます:
プロジェクト管理
プロジェクトメンバー管理
組織
#
「組織」は管理と協力の最上位レベルで、通常は会社や大規模なチームを表します。これにより、中央から複数のチームを管理し、統一された権限とリソース配分が可能になります。これにより、チーム全体のAPIプロジェクトを監督しやすくなり、データの安全性とシームレスな協力を確保します。
組織設定により、管理者は異なるチームに特定の権限を割り当て、すべてのプロジェクトを中央で管理できます。各組織には複数のチームが存在でき、各チームのデータとプロジェクトは分離されており、情報の安全性とプライバシーを保護します。
チーム、プロジェクト、組織の違い
#
Apidogでは、「
チーム
」、「
プロジェクト
」、「
組織
」は異なる管理と協力のレベルを表し、それぞれが異なる役割を果たします:
組織:
これは管理の最上位レベルで、会社や大規模なチームを表します。複数のチームとプロジェクトを中央で管理し、チーム間の権限を管理する権限を持っています。
チーム:
チームは組織内の小さな単位で、通常は部門やグループを表します。特定のAPIプロジェクトを管理し、チームメンバーがこれらのプロジェクトで協力し、管理者がチームレベルでプロジェクトの権限を監督・管理します。
プロジェクト:
チーム内の作業単位で、特定のAPIリソースとドキュメントを管理します。各プロジェクトは独立したワークスペースとして機能し、特定のタスクを管理・協力しやすくします。
まとめ:
組織
は複数のチームを管理します。
チーム
は特定のAPIプロジェクトを扱います。
プロジェクト
はAPIの設計と開発が行われる場所です。
Modified at
2025-02-21 10:22:45
Previous
OAuth 2.0で保護されたAPIにアクセスする方法
Next
Apidogスタートアップガイド