Django/flas中restfulapi的注释样式指南

Question

对于restfulapi类或函数，是否存在事实上的注释风格？如果没有，那么如何将google/sphinx注释样式应用于restapi呢？在

例如，我如何为

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

如果api使用一些查询字符串参数？在

Answer 1

您可以查看flask或{a2}的Swagger扩展

Swagger可以为文档和测试生成html页面。在

你还可以看看：

• 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