Как создать документацию для «других» URLconfs из приложений, включенных в проект urls.py - PullRequest
0 голосов
/ 25 октября 2019

Я работаю над проектом, используя следующие зависимости:

Python 3.7

django 2.2.6

djangorestframework 3.9.4

Ясоздание нескольких приложений, и каждое из этих приложений имеет свои собственные файлы urls.py, которые включены в файл URL-адресов родительского проекта. Я хочу создать документацию для конечных точек API, описанных во включенных файлах URLconf. Однако swagger только документирует URL-адреса, сопоставленные в родительском файле URLconf.

Я уже пытался включить представление swagger в URLconfs проектов, но он все еще обслуживает только родительский URLconf.

По сути,Я добавил код ниже для всех моих URLconf

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='Some APIs')

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

1 Ответ

0 голосов
/ 25 октября 2019

Это сделал трюк:

from rest_framework.documentation import include_docs_urls

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