Add view documentations - Githubissues

bounswe / bounswe2017group5

Interestr - Build your own interest-based community

MIT License

6 stars 3 forks source link

Add view documentations #109

Closed smddzcy closed 7 years ago

smddzcy commented 7 years ago

About

Related Issues: #97

We should follow http://www.django-rest-framework.org/topics/documenting-your-api/ and document our views so that we can automatically generate an API documentation.

Changes

Document the views.
Set up the auto-documentation generation.

Visuals

screen shot 2017-10-31 at 17 35 15

Testing

Open the project and install the new dependencies.
Run the server.
Go to ...api-base-url.../api/v1-docs, you should see a page like the one in the image above.