评论django / flask

Question

对于restful api类或函数，是否有任何事实上的评论风格？如果没有，那么我如何应用google / sphinx评论风格来休息apis？

例如，我如何为

撰写评论

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

如果api需要一些查询字符串参数？

Answer 1

您可以查看flask或Django

的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