Django REST Framework 结合来自不同应用程序的路由器

Question

我有一个跨越多个应用程序的项目：

./project/app1
./project/app2
./project/...

每个应用程序都有一个用于 Django REST 框架的路由器，用于合并该应用程序提供的 API 部分：

from django.conf.urls import url, include
from rest_framework.routers import DefaultRouter
from .views import ThingViewSet

router = DefaultRouter()
router.register(r'things', ThingViewSet, base_name='thing')

urlpatterns = [
    url(r'^', include(router.urls)),
]

因为应用程序是独立的，所以我的顶级 URL 文件 (./project/urls.py) 包含来自不同应用程序的每个 URL 文件：

url(r'^api/app1/', include('app1.urls', namespace='a1')),
url(r'^api/app2/', include('app2.urls', namespace='a2')),

这意味着 Django REST Framework 为每个应用程序显示一个单独的 API 根。然而，我想要的是一个统一的 API 结构，因此如果我导航到 http://example.com/api/，我会看到在该层次结构级别上可用的所有 URL 的完整列表。

我认为有一种方法可以将每个应用程序的单独 urls.py 文件中定义的所有单独路由器包含到单个路由器中，但我找不到有关如何执行此操作的文档。我错过了什么明显的东西吗？

Answer 1

我最终在 urls_api_v1.py 中创建了一个包含我想要的所有路由的 URLs 文件：

router = DefaultRouter()
router.register(r'app1/foos', FooViewSet, base_name='foo')
router.register(r'app2/bars', BarViewSet, base_name='bar')
router.register(r'app2/bazs', BazViewSet, base_name='baz')

作为一个副作用，这让我可以删除每个应用程序中的所有单独的 urls.py 文件，这是您通常想要的，但在这种情况下，整个应用程序集合需要一个统一的 URL 结构，因此删除更多明智的。

然后我从urls.py引用它：

import api_v1
urlpatterns = patterns('',
    ...,
    url(r'^api/v1/', include(api_v1, namespace='api-v1')),
)

现在，如果我想更改 v2 的路由，我也可以包含一个 v2 URLs 文件并最终弃用 v1 文件。

Answer 2

这将获取基本 API URL 上列出的所有 ViewSet 路由。

它将路由定义为相应包含的 app.urls 中的列表，以便它们可以在其他地方注册。

将它们包含在基本 urls.py 中后，将构建列表的嵌套列表并循环访问以在 API 中注册同一级别的所有路由

# foo.urls
routeList = (
    (r'foos', FooViewSet),
)

# barBaz.urls
routeList = (
    (r'bars', BarViewSet),
    (r'bazs', BazViewSet),
)

# urls
from rest_framework import routers
from foo import urls as fooUrls
from barBaz import urls as barBazUrls

routeLists = [
    fooUrls.routeList,
    barBazUrls.routeList,
]

router = routers.DefaultRouter()
for routeList in routeLists:
    for route in routeList:
        router.register(route[0], route[1])

结果：

{
    "foo": "http://localhost:8000/foos/",
    "bar": "http://localhost:8000/bars/",
    "baz": "http://localhost:8000/bazs/",
}

这在每个文件中的重复也更少，并且可以说更容易阅读。

此外，它仍然完全解耦。

如果包含的应用程序在其他地方使用，则可以在内部使用相同的方法来注册它自己的路由，而不会被包含在任何地方。

只需放下外部循环

routeList = (
    (r'bars', BarViewSet),
    (r'bazs', BazViewSet),
)

router = routers.DefaultRouter()
for route in routeList:
    router.register(route[0], route[1])

Answer 3

另一种解决方案是使用SimpleRouter 为各个应用定义路由器。然后，使用自定义的DefaultRouter 来包含应用特定的路由。这样，所有应用特定的 url 定义都将保留在相应的应用中。

假设您有两个名为“app1”和“app2”的应用程序，每个应用程序都有一个名为“api”的目录，在此目录中有一个名为“urls”的文件，其中包含您的所有路由定义。

├── project/ │ ├── api_urls.py │ ├── app1 │ │ ├── api │ │ │ ├── urls.py │ ├── app2 │ │ ├── api │ │ │ ├── urls.py │ ├── patches │ │ ├── routers.py

使用patches/router.py 定义一个名为DefaultRouter 的类，该类继承自rest_framework.routers.DefaultRouter。

from rest_framework import routers

class DefaultRouter(routers.DefaultRouter):
    """
    Extends `DefaultRouter` class to add a method for extending url routes from another router.
    """
    def extend(self, router):
        """
        Extend the routes with url routes of the passed in router.

        Args:
             router: SimpleRouter instance containing route definitions.
        """
        self.registry.extend(router.registry)

用路由定义填充您的 api url，例如

"""
URL definitions for the api.
"""
from patches import routers

from app1.api.urls import router as app1_router
from app2.api.urls import router as app2_router

router = routers.DefaultRouter()
router.extend(app1_router)
router.extend(app2_router)

Answer 4

如果您正在实现 SimpleRouter，您只需将其 url 与 urlpatterns 列表连接起来

router = SimpleRouter()
router.register(r'import-project', ImportProject, base_name='di-integ')

在主 urls.py 文件中

from di_apiary_integration.urls import router as di_integration_routers

要注册 URL，您可以：

url(r'^di-integration/', include(di_integration_routers.urls)),

或

urlpatterns += di_integ_router.urls

两者都可以！

重要

ImportProject 需要是 ModelViewSet 或 ViewSet，如果您将其创建为简单的 APIView，则需要使用 as_view() 将其注册为普通 CBV 视图

Answer 5

@Colton Hicks评论

假设我们在“应用程序文件夹”中有 2 个应用程序（权限、用户）。然后我们可以这样做：

from apps.users.api.urls import router as users_router
from apps.permissions.api.urls import router as permissions_router


router = DefaultRouter()
router.registry.extend(users_router.registry)
router.registry.extend(permissions_router.registry)

Answer 6

可以使用router.registry.extend(app_router.registry)，总例：

from django.urls import path, include
from rest_framework import routers
from app1.rest import router as app1_router
from app2.rest import router as app2_router

router = routers.DefaultRouter()
router.registry.extend(app1_router.registry)
router.registry.extend(app2_router.registry)

urlpatterns = [
    path('', include(router.urls)),
]