To facilitate development of the Flask API, a consensus should be reached on how the frontend and backend will communicate through this API. Some design points to address:
- What are the API endpoints? (E.g. is the target polling session endpoint "join.click.in/xYz6" or "click.in/xYz6"?)
- What types of requests do these endpoints support? (e.g. HTTP requests: GET, PUT, POST, DELETE)
- What are the parameters to each endpoint? (e.g. three-character session hash)
- What functionality should each endpoint support? (e.g. "it should route user to target polling session page and authenticate if previously logged in.")
- What data should responses return, and in what format? (e.g. a JSON list of a student's/professor's courses)
- How should errors be handled? (e.g. 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Internal Server Error)
To facilitate development of the Flask API, a consensus should be reached on how the frontend and backend will communicate through this API. Some design points to address: