API Contract template

What is an API contract and why do we make them?

An api contract is responsible for the planning an execution of an api endpoint. It defines the Method, path, description and a sample payload and response before the implementation of the endpoint so all parts of the team understands what is being made. This allows the team to forecast future implementations of the api and allow other teams to create exact functionality referring to the API contract. You will be using the api contract to model your unit tests off of to ensure you code gives the correct response.

API contract template

Method	Path	Description	Sample payload and response
GET	/createRoom?groupCode={HX8192}	Create roomId for others to join in database Note: * no security, global access	Sample 200 Response: { "roomId": "HX8192" }

Since github wiki is made with markdown, I suggest using this Markdown table generator and adding the api contract to the page on the wiki listed API Contract's