如何从项目urls.py中包含的应用程序为“其他” URLconf生成详尽的文档

Question

我正在使用以下依赖项从事项目：

Python 3.7

django 2.2.6

djangorestframework 3.9.4

我正在创建多个应用程序，并且每个应用程序都有自己的urls.py文件，这些文件包含在父项目的URL文件中。我希望为随附的URLconf文件中描述的API端点创建详尽的文档。但是，只能摇摇晃晃地记录在父URLconf文件中映射的URL。

我已经尝试过将swagger视图包含在项目的URLconf中，但它仍然仅提供父URLconf。

基本上，我已将以下代码添加到我的所有URLconf中

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='Some APIs')

urlpatterns = [
    path('', schema_view),
]

Answer 1

这可以解决问题：

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    path('docs/', include_docs_urls(title=API_TITLE, description=API_DESCRIPTION))
]