Skip to main content

Friend API - src/pages/api/friend.ts

PUT /api/friend. Creates new friend code and updates the user with that.

GET /api/friend. Gets friends on initial connection.

handler(req: NextApiRequest, res: NextApiResponse): Promise<void>

Method: PUT and GET only. Returns 405 for any other method.

Returns: { newFriendCode } or { friends, friendRequests, friendCode }

Preconditions:

  • Must be signed in

Error responses:

StatusConditionBody
405Non-GET or Non-PUT request{ error: "Method not allowed" }
401Not authorized{ error: "Not authorized" }

Examples:


GET /api/friend
-> 200 { friends, friendRequests, friendCode }

PUT /api/friend
-> 200 { newFriendCode }

POST /api/friend
-> 405 { error: "Method not allowed" }