django - 在 Django RestFramework 中，如何更改 Api Root 文档？

Question

在 django RestFramework 中，是否有任何“官方”方式来生成“Api Root”的文档？

在查看了 RestFramework 的源代码后，我通过继承 DefaultRouter 找到了一种解决方法:

from rest_framework import routers

class MyRouter(routers.DefaultRouter):
    def get_api_root_view(self):
        api_root_view = super(MyRouter, self).get_api_root_view()
        ApiRootClass = api_root_view.cls

        class MyAPIRoot(ApiRootClass):
            """My API Root documentation"""
            pass

        return MyAPIRoot.as_view()

router = MyRouter()

有没有更清洁或更好的方法？

Answer 1

如果有人想要内联样式

   router = DefaultRouter()

   router.get_api_root_view().cls.__name__ = "Root API name"
   router.get_api_root_view().cls.__doc__ = "Your Description"