api文档中自定义代码示例的问题

Question

我正在尝试将快速代码示例添加到django-rest-framework项目中的自动生成的api文档中。

docs说，我必须对DocumentationRenderer进行子类化，并添加所需的语言并为其创建模板。但这并没有告诉我如何处理子类渲染器。

from rest_framework.renderers import DocumentationRenderer


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

因此，我在core / serializers.py下的文件中创建了“ CustomRenderer”，这很好吗？我在哪里可以引用该类，以便我可以实际使用它？

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

Answer 1

include_docs_urls() 函数采用可选参数 renderer_classes ，默认情况下为 None 。

您可以检查source code of include_docs_urls() here...

---

因此，您的 CustomRenderer 类可以通过include_docs_urls()中的 urls.py 来提供，

from rest_framework.documentation import include_docs_urls

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