コメント機能

Apidogでは、すべてのAPIにコメント機能が備わっており、チームメンバーがAPIドキュメント上で直接ディスカッションやコラボレーションを行うことができます。

コメントの表示・追加

コメントを閲覧・追加するには、任意のAPIを開き、右上の「コメント」アイコンをクリックしてください。コメントパネルがページのサイドからスライド表示され、既存のディスカッションを確認したり、新たなフィードバックを投稿したりすることが容易に行えます。

コメント内では「@」を利用してプロジェクトメンバーをメンションできます。投稿後、メンションされたメンバーにはメールおよび受信箱で通知が届きます。

メールおよび受信箱での通知を受け取るには、「設定」→「通知」（画面右上）で有効化しておく必要があります。無効の場合、関連する通知は届きません。

メール通知の例：

受信箱通知の例：

「@」メンション機能を適切に活用することで、重要な課題についてチームメンバーに迅速に通知できます。なお、現時点では通知はメールおよび受信箱のみ対応しており、SlackやTeamsなどのサードパーティチャネルには未対応です。

コメント内に画像を直接挿入することができ、リクエスト例やスクリーンショット、エラーログなどの詳細情報を共有できます。

アップロード方法：コメント入力欄の画像アイコンをクリックしてローカル画像を選択するか、画像をコピー＆ペーストで入力欄に貼り付けてください。挿入した画像はクリックで拡大表示が可能です。

コメントが多い場合は、フィルター機能を活用することで、必要なコメントを素早く見つけることができます。

未解決： まだ対応されていないコメントのみを表示します。

解決済： 解決済みとしてマークされたコメントのみを表示し、過去のディスカッションを振り返る際に便利です。

チームでコラボレーションを行う際は、対応が完了した課題を速やかに「解決済みとしてマーク」し、コメント一覧を整理・明確に保つよう心がけてください。