Django Rest Framework-版本化文档

时间:2019-06-10 14:17:51

标签: django django-rest-framework

我有一个使用Django Rest Framework NamespaceVersioning

的API版本
REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS':
        'rest_framework.versioning.NamespaceVersioning'
}

这很奇妙,我可以访问所有的v1和v2端点。

url(r'^v1/', include((router.urls, 'v1'), namespace='v1')),
url(r'^v2/', include((router.urls, 'v2'), namespace='v2')),

我还按照official docs

的建议使用内置API文档。
from rest_framework.documentation import include_docs_urls

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

我的问题是我想为版本1和2使用不同的文档,因为每个版本的某些序列化程序都不同。

如果我做这样的事情:

url(r'^v1/docs/', include_docs_urls(title='My API title'))
url(r'^v2/docs/', include_docs_urls(title='My API title'))

我收到以下警告。

WARNINGS:
(urls.W005) URL namespace 'api-docs' isn't unique. You may not be able to reverse all URLs in this namespace

有推荐的方法吗?

0 个答案:

没有答案