python - Commenting style guide for restful apis in django / flask -

is there de-facto commenting style restful api classes or functions? if there's no such, how apply google / sphinx commenting style rest apis?

for example, how write comment for

class mylistapi(apiview):     def get(self, request, **kwargs):         ... 

if api takes query string parameters?

you can check out swagger extension flask or django

swagger can generate html page docs , testing.

you can at:

• http://www.django-rest-framework.org/topics/documenting-your-api/
• https://github.com/noirbizarre/flask-restplus
• https://github.com/hobbeswalsh/flask-sillywalk
• https://pythonhosted.org/sphinxcontrib-httpdomain/#module-sphinxcontrib.autohttp.flask