Skip to content

Instantly share code, notes, and snippets.

@whopdan
whopdan / broadvibe-fe-api-req-doc.md
Last active October 28, 2025 04:09
Broadvibe Frontend to Backend Documentation

Objective

Use some sort of documentation to define and communicate how the new frontend code will make REST calls/requests to the backend web server

Information to Document

  • Frontend page and page region (if applicable)
  • Web server route (e.g. api/dashboard)
  • REST method (GET, POST, PUT,...)
  • Request parameters