Documenting @api_view() methods properly

[silverj87]

Hello,

I am new to django rest framework but have several back-end endpoints that are wrapped by @api_view (they do not relate to a model) and return JSON responses.

Is there a best practice for documentation? I attempted to use django-rest-swagger but have not found a good way of informing the doc generation of the input param types and a good description of the end point. django-rest-swagger deprecated the YAML doc strings prior to version 2.0 and I'm having a hard time finding an approach that will work for sphinx and the api documentation simultaneously.

Restriction:

- Sphinx is used to document the project in it's entirety (so .rst files using doc strings formatted with restructred text)

Versions:

python 3.6.2

django 1.11.7

djangrestframework 3.7.3

Any help or examples would be greatly appreciated.

[Jason]

FWIW, I tend to make subclasses of APIView and implement the functionality there

[silverj87]

Thanks for the advice. I saw that... little more verbose but if it helps make documentation easier to follow I suppose it's a good practice. Thanks!