Apidog のメインインターフェースは、次の主要なエリアに分かれています。ヘッダー: プロジェクト管理とユーザー設定を行う上部ナビゲーションです。
サイドバー: 主要機能にアクセスするための左側パネルです。
ワークベンチ: ディレクトリツリー、タブ、環境セレクターを含む中央エリアです。
フッター: ステータス、ツール、コミュニティリンクを表示する下部バーです。
ヘッダー#
ヘッダーでは、重要な機能にすばやくアクセスできます。| 機能 | 説明 |
|---|
| ホーム | チーム、プロジェクト、API ハブを含む個人ホームページにアクセスします。 |
| プロジェクトタブ | プロジェクトを切り替えます。名前の横にあるボタンをクリックすると、新しいウィンドウで開きます。 |
| アップグレード/プラン | チームの現在のプランを表示します。 |
| 更新 | プロジェクトデータを再読み込みします。注: これにより、開いているすべてのタブが閉じられます。 |
| 設定 | 外観やプロキシなどのローカル設定を構成します。 |
| 通知 | チームアクティビティのアラートを確認します。 |
| アバター | アカウント設定とアクセストークンを管理します。 |
プロジェクトを切り替えるには、ヘッダー内の任意のプロジェクトタブをクリックします。
サイドバー#
サイドバーは、Apidog の主要機能を整理しています。| 機能 | 説明 |
|---|
| プロジェクトアイコン | チームとプロジェクトの概要に移動します。 |
| APIs | 定義、デバッグ、リクエスト送信、スキーマの作成、ドキュメントの作成を行います。 |
| テスト | バッチリクエストを実行し、シナリオを作成し、レポートを表示し、CI/CDを管理します。 |
| ドキュメント共有 | カスタマイズオプションを使用して API ドキュメントを共有および公開します。 |
| 履歴 | 送信済みリクエストを表示し、再送信します。 |
| 設定 | プロジェクト設定、通知、データを管理します。 |
| 招待 | ユーザーをプロジェクトに招待します。 |
サイドバーを使用すると、APIs やテストなど、よく使用する機能にすばやくアクセスできます。
ワークベンチ#
ワークベンチは、プロジェクト要素を管理するための中央ワークスペースです。ディレクトリツリー#
ディレクトリツリーは、プロジェクトコンポーネントを階層的に 整理します。| 機能 | 説明 |
|---|
| ブランチとバージョン | ブランチを切り替える、またはバージョンを管理します。デフォルトは main ブランチです。 |
| 検索とフィルター | エンドポイントを検索します（フォルダーやケースは対象外です）。 |
| 新規作成 | エンドポイント、リクエスト、スキーマなどを追加します。 |
| <Project Name> | 上位レベルのプロジェクトビューです。 |
| エンドポイント | エンドポイントとケースをフォルダー内で整理します。 |
| スキーマ | スキーマをフォルダー内で管理します。 |
| コンポーネント | 再利用可能なレスポンスコンポーネントです。 |
| Admin API | 管理者がデータを一括処理するためのツールを含みます。 |
| クイックリクエスト | このプロジェクトで作成されたクイックリクエストを整理します。 |
新しいエンドポイントを作成するには、ディレクトリツリー内の新規作成アイコンをクリックします。
閲覧モード: シングルクリックすると斜体のタブが開き、新しくクリックすると上書きされます。
編集モード: ダブルクリックするか編集すると、タブが通常表示になります（上書きを防ぎます）。
その他: タブを閉じます（すべて、現在、またはその他）。
複数の要素を編集する際にタブを 保持するには、ダブルクリックを使用します。
環境セレクター#
API をテストするための環境を選択します。開発、ステージング、本番環境を切り替えて、リクエストが正しい設定を使用するようにします。例: ワークベンチの環境ドロップダウンをクリックしてコンテキストを変更します。フッター#
フッターには、ステータスとユーティリティツールが表示されます。| 機能 | 説明 |
|---|
| 折りたたみ/展開 | ディレクトリツリーの表示を切り替えます。 |
| オンライン | 接続ステータスを表示します。オフラインの場合、同期に影響します。 |
| Agent | リクエストに使用するエージェントを選択します（Apidog Web のみ）。 |
| Cookies | Cookie を管理します。 |
| ゴミ箱 | 削除された項目を表示します（30 日後に自動削除されます）。 |
| コミュニティ | Discord、Slack、X、またはEmailで Apidog コミュニティに参加します。 |
チームの同期を確保するには、オンラインステータスを確認してください。
