根据父文档字符串生成视图描述

时间:2014-07-22 16:37:49

标签: python django django-views django-rest-framework

如何从父视图中为基于Django-REST-Framework的API生成基于类的视图描述(对嵌套的资源有用)?

我有一个父类,如:

class ParentView(GenericAPIView):
    """
    My parent endpoint documentation
    """
    pass

和儿童班一样:

class ChildView(ParentView):
    """
    My child endpoint documentation
    """
    pass

在浏览子视图的交互式API时,生成的描述是"我的子端点文档"但是我希望拥有"我的父端点文档"代替。

1 个答案:

答案 0 :(得分:1)

解决方案是在子视图中重载get_view_description方法,如:

class ChildView(ParentView):
    def get_view_description(self, html=False):
        """
        Get the view description based on the parent class docstring
        """
        func = self.settings.VIEW_DESCRIPTION_FUNCTION
        return func(self.__class__.__base__, html)

这样做,您应该能够通过父文档字符串记录您的子视图。