Apidog では、プロジェクトは API の設計、テスト、ドキュメント化を行う中核的なワークスペースです。このガイドでは、チーム内でプロジェクトを作成、管理、整理する方法について説明します。プロジェクトの作成#
新しいプロジェクトを作成するには、チームに移動し、New Project ボタンをクリックします。Settings の Basic Settings セクションで、プロジ ェクト名とアイコンをカスタマイズできます。プロジェクト概要#
既存のプロジェクトでは、APIs 配下の Overview ページで主要な情報と統計を確認できます。エンドポイントケース/テストシナリオの統計#
このセクションでは、現在のプロジェクトのすべてのエンドポイントを表示し、テストカバレッジに関する 統計を提供します。関連するテストステップを持つエンドポイントの割合、およびテストシナリオ内でテスト済みのエンドポイントの割合が表示されます。これらの統計は、API テストの網羅性と全体的な信頼性を評価するうえで有用です。エンドポイントケースのカバレッジ: 関連するケースを持つエンドポイント数 / エンドポイント総数。これは主に、個々のエンドポイントに対応するケースがあ るかどうかを確認するために使用されます。
エンドポイントあたりの平均ケース数: ケース総数 / エンドポイント総数。これは主に、エンドポイントケース全体の完全性を評価するために使用されます。
ケースのないエンドポイント: ケースがないエンドポイントの数を示します。
テストシナリオのカバレッジ: テストシナリオでカバーされているエンドポイント数 / エンドポイント総数。これは主に、自動テストによってエンドポイントがどの程度カバーされているかを評価するために使用されます。
どのテストシナリオにもカバーされていないエンドポイント: 自動テストでまだカバーされていないエンドポイントの数を示します。
データの計算は非同期で行われるため、遅延が発生す る場合があります。不一致が発生した場合は、しばらくしてから更新して確認してください。
プロジェクトの編集#
チームの所有者/管理者は、作成済みのプロジェクトに入り、Settings → Basic Settings でプロジェクト名またはプロジェクトアイコンを変更できます。プロジェクトの複製#
現在のチームから別のチームへプロジェクトを複製するには、Settings → Basic Settings → Clone Project をクリックします。プロジェクトの移動#
プロジェクトを別のチームへ移動するには、Settings → Basic Settings → Move Project をクリックします。プロジェクトの削除#
プロジェクトを完全に削除するには、Settings → Basic Settings → Delete に移動します。注意が必要です。削除されたプロジェクトは復元できません。