Django REST框架:如何在URL中添加前缀用于版本控制

时间:2014-11-05 12:56:34

标签: django django-rest-framework django-urls

我正在尝试为REST应用程序创建版本。这是我的URL Examle

www.myapi.com/foo [default version]
www.myapi.com/v1/foo [version one]

这是项目结构

├── __init__.py
├── settings.py
├── urls.py
├── default_app
│ ├── __init__.py
│ ├── serializer.py
│ ├── models.py
│ ├── views.py
│ ├── urls.py
│ 
└── v1_app
├── __init__.py
├── serializer.py
├── models.py
├── views.py
├── urls.py

default_app urls.py

from django.conf.urls import *
from default_app import views as df_views
from rest_framework import routers

router = routers.DefaultRouter()
router.register(r'foo', df_views.viewname, "foo")
urlpatterns = router.urls

v1_app urls.py

from django.conf.urls import *
from v1_app import views as ver_views
from rest_framework import routers

router = routers.DefaultRouter()
router.register(r'foo', ver_views.viewname, "foo")
urlpatterns = router.urls

urls.py的主要文件

from django.conf.urls import patterns, include, url
from defualt_app import urls as default_urls
from v1_app import urls as v1_urls
from django.contrib.staticfiles.urls import staticfiles_urlpatterns



urlpatterns += patterns('',
    url(r'^', include(default_urls, namespace="default")),
    url(r'^v1/', include(v1_urls, namespace="v1"))
)

urlpatterns += staticfiles_urlpatterns()

我的问题是,当我使用没有任何前缀的简单网址时,它正在工作

  

www.myapi.com/foo

当我使用版本前缀v1或v2时,它会抛出错误[找不到页面(404)]

  

www.myapi.com/v1/foo

我从这个链接得到了这个想法 https://stackoverflow.com/a/21839842/1558544

如果我不使用中间件类,那么这可能会得到相同的结果吗?

谢谢

1 个答案:

答案 0 :(得分:1)

Django REST Framework不支持url名称空间,但是有一些解决方案可以让它们适用于大多数情况。

对于序列化程序,您必须定义使用HyperlinkedRelatedField进行超链接的所有字段,包括自动添加的url字段,即HyperlinkedIdentityField。这包括将所有字段的view_name参数设置为正确的自动生成的视图名称。这应该是[namespace]:[base_name]-detail

但这也意味着您不能使用由DefaultRouter生成的DefaultRouter索引页,因为它根本不处理命名空间。为了获得一个,您将需要创建自己的,或覆盖路由器中自动生成的视图。