Document API

[djbusstop]

Is your feature request related to a problem? Please describe.
It's much easier to develop the frontend when we know how the API works. We have had problems of not knowing what to expect from the API and it led to developing the frontend for features we didn't actually have.

Describe the solution you'd like
Implement documentation for the API. Ideally with a self documenting API plugin on django

Describe alternatives you've considered
Writing the docs by hand.

Additional context
N/A

[djbusstop]

https://github.com/opt-out-tools/public_api/blob/master/README.md

The readme is already pretty good, actually. But would be best to generate.

[Cheukting]

I will give it a go, can someone assign it to me?

[djbusstop]

@Cheukting done :)

[lucie-docs]

Thought this could help for this issue: https://medium.com/@arjunsinghy96/customised-api-documentation-for-django-rest-framework-projects-using-drf-yasg-d6db9ba5cff3

We've built the API docs using Redoc in my company, this is how it looks like: https://api-documentation.relayr.io/