在应用中注册API

两种选择都是可能的.您可以公开router或urls在每个应用程序中,并将它们合并到您的全局urls.我通常更喜欢使用urls(选项2),因为它在每个应用程序中提供了更大的灵活性:您可以根据需要定义额外的非api URL.

选项1

在你的全球urls.py中:

from app1.api.routers import router1
from app2.api.routers import router2

urlpatterns = patterns('',
    url(r'^snippets/', include('snippets.urls', namespace="snippets"))
    ...
    url(r'^app1/api/', include(router1.urls)),
    url(r'^app2/api/', include(router2.urls)),
)

您可以轻松地为两个路由器使用相同的端点(只要您注意不要使用冲突的路由):

urlpatterns = patterns('',
    url(r'^snippets/', include('snippets.urls', namespace="snippets"))
    ...
    url(r'^api/', include(router1.urls)),
    url(r'^api/', include(router2.urls)),
)

选项2

在appN/api/urls.py中:

router = DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(include('app1.apis')

urlpatterns = patterns('',
    url(r'^', include(router.urls)),
    url(r'^misc/', some_other_view),
)

在你的全球urls.py中:

urlpatterns = patterns('',
    url(r'^snippets/', include('snippets.urls', namespace="snippets"))
    ...
    url(r'^api/', include('app1.api.urls')),
    url(r'^api/', include('app2.api.urls')),
)

请注意,urls模块不需要与urls标准视图相同.

通过绕过单个路由器实例，如下是可能的。

router.py在您的main项目文件夹中创建一个名为或类似文件：

from rest_framework import routers
common_router = routers.DefaultRouter()

在每个应用程序的位置urls.py：

from main.router import common_router as router
router.register(r'myapp-model-name', MyAppViewSet) 

在您的内容中main urls.py：

import my_app1.urls  # to register urls with router
import my_app2.urls  # to register urls with router
...
# finally import router that includes all routes
from main.router import common_router

urlpatterns = [
    ...
    url(r'^api/', include(common_router.urls)),
    ...
]

要在同一个API根目录中获取所有应用程序,您需要使用相同的DefaultRouter注册所有应用程序.

实现此目的的一种方法是创建一个自定义路由器,它拦截寄存器调用并将其传播到共享路由器.然后,您可以使用此共享路由器来获取API.

class SharedAPIRootRouter(SimpleRouter):
    shared_router = DefaultRouter()

    def register(self, *args, **kwargs):
        self.shared_router.register(*args, **kwargs)
        super().register(*args, **kwargs)
        # if not py3: super(SharedAPIRootRouter, self).register(*args,**kwargs)

然后在每个应用程序:

# in app1/urls.py 
router = SharedAPIRootRouter()
router.register(r'app1', App1ModelViewSet)

# in app2/urls.py
router = SharedAPIRootRouter()
router.register(r'app2', App2ModelViewSet)

在您的主urls.py中,您必须确保导入应用程序URL,以便在我们请求shared_router.urls之前进行注册

import app1.urls
import app2.urls

def api_urls():
    return SharedAPIRootRouter.shared_router.urls

urlpatterns = patterns(
    '',
    url(r'^api/', include(api_urls())),   
)   

如果您不想显式导入网址,可以按惯例执行:

def api_urls():
    from importlib import import_module
    for app in settings.INSTALLED_APPS:
        try:
            import_module(app + '.urls')
        except (ImportError, AttributeError):
            pass
    return SharedAPIRootRouter.shared_router.urls