NIAEFEUP / tts-be

A platform where students can experiment with the possible combination of schedule options they can pick at the start of the semester
https://tts.niaefeup.pt
5 stars 1 forks source link

Add documentation for API endpoints #84

Open tomaspalma opened 2 months ago

tomaspalma commented 2 months ago

We should have a swagger file with the endpoints, explaining the possible request and response examples.

In the current state we need to look at the code of the backend in order to understand what the endpoints do which is not desirable at all.

We can create an Open API specification file (example here) and then host it on our backend like the example here