stutea Add API documentation in /backend/README.md

What all things to include in API Documentation:

An Overview which describes what API does.
Description of each API alongside with some examples wherever possible.
List down the status code and their meaning.

Jan 26 '23 13:01 Ishwarendra

Assign me

Jan 27 '23 13:01 kavyarishi19

Any updates @kavyarishi19 ?

Feb 01 '23 08:02 Ishwarendra

Hi, I am very interested in helping with your documentation, but need a bit of help to get started. Particularly, I am having trouble finding exactly what I should be documenting. I have forked the project and can see where to edit the backend readme.md. Sorry for being a newbie, but I hope that I can help in the end!

Mar 27 '23 22:03 jklein23

You should be documenting all the api endpoints we have.

And for the details part, you need to include the request body, headers and response type, body etc.

You can follow any standard api documentation format.

Mar 27 '23 23:03 harshjohar

Just wanted to let you know that I am working on this!

Mar 30 '23 18:03 jklein23

Do you have a Postman collection for this project?

Apr 07 '23 15:04 jklein23

We didnt use postman while developing, instead used a similar vscode extension called ThunderClient.

You can install this in vscode

And then import the thunder_collection.json file in the backend folder to see it.

It is very similar to postman if you have already worked with postman.

Apr 07 '23 17:04 harshjohar

It doesn't look like I am going to have time to finish this, unfortunately.

Apr 25 '23 15:04 jklein23

Hi,

Is this still open? If yes, then can you please share the .json file. I do not see the file in the backend folder and the existing one throws up an error when I import.

Thanks, Abhishek

Jul 03 '23 12:07 a-sura