проблема с настройкой примеров кода в документации API - PullRequest
Новая
       6

проблема с настройкой примеров кода в документации API

0 голосов
/ 28 декабря 2018

Я пытаюсь добавить быстрые примеры кода в автоматически сгенерированную документацию API в моем проекте django-rest-framework.

В документах говорится, что я должен создать подкласс DocumentationRenderer и добавить нужные языки, а также создать шаблоны для них.Но это не говорит мне, что делать с подклассом Renderer. 

from rest_framework.renderers import DocumentationRenderer


class CustomRenderer(DocumentationRenderer):
    languages = ['ruby', 'go']

Так что я создал "CustomRenderer" в моем файле в core / serializers.py отлично, что теперь?Где я могу сослаться на этот класс, чтобы я мог его применить?

https://www.django -rest-framework.org / themes / documenting-your-api / # customizing-code-samples

1 Ответ

0 голосов
/ 28 декабря 2018

Функция include_docs_urls() принимает необязательный аргумент, renderer_classes, который по умолчанию равен None.

Вы можетепроверьте исходный код include_docs_urls() здесь ...

Итак, Ваш CustomRenderer класс можетпредоставляется через include_docs_urls() в urls.py as, 

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    url(r'^docs/', include_docs_urls(title='My API title',<b>renderer_classes=CustomRenderer</b>))
]
...