In Apidog, every endpoint supports comments, allowing team members to discuss and collaborate directly on the endpoint documentation.To view or add comments, simply open any endpoint and click the "Comments" icon in the upper right corner. The comment panel will slide out from the side of the page, making it easy to check existing discussions or post new feedback.In comments, you can use@to mention project members. Once posted, the mentioned members will receive a notification, including email and inbox.Email and inbox need to be enabled in Settings -> Notifications (top right corner). Otherwise, members won't receive related alerts.Email Notification Example:Inbox Notification Example:Using the @ mention feature wisely ensures that team members are promptly alerted to important issues. Currently, notifications only support email and inbox βthird-party channels such as Slack or Teams, are not supported.Image Upload Support#
You can insert images directly in comments to provide additional details, such as request examples, screenshots, or error logs.How to upload: Click the image icon in the comments input box and select a local image, or simply copy and paste the image into the input box. Images can be clicked to enlarge.When there are many comments, use the filter feature to quickly find what you need:Open: Shows only comments that have not yet been addressed.
Resolved: Shows comments marked as resolved, making it easy to review past discussions.
Modified atΒ 2025-09-17 06:10:40
