Django / Flask中的Restful API的注释样式指南

Question

Is there any de-facto commenting style for restful api classes or functions? If there's no such, then how do I apply google / sphinx commenting style to rest apis?

For example, how do I write comment for

class MyListAPI(APIView):
    def get(self, request, **kwargs):
        ...

if the api takes some query string parameters?

Answer 1

You can check out Swagger extension for flask or Django

Swagger can generate html page for docs and testing.

You can also look 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