search

lhei-git / ToxicantVisualizer

Fall 2020 Capstone Project
0 stars 1 forks source link

Add documentation skeleton to API #11

Open evandejesus opened 3 years ago

evandejesus commented 3 years ago

The frontend developers need to know how to use the API endpoints that are created, most importantly how the request must be formatted and how the response will be formatted. This is important to document so frontend devs do not have to look through backend code to understand how to use it, as well as avoiding unnecessary questions down the line.

Along with route documentation, we should include a README.md of how to develop and run the backend. See the frontend folder for an example.

How to create documentation for the djangorestframework package: https://www.django-rest-framework.org/topics/documenting-your-api/#generating-documentation-from-openapi-schemas

adwait97 commented 3 years ago

I'll add the readme for running and development for the backend but the URL structure and sample response is in the testing document(s)