django 接口路由嵌套的实现示例

# project/urls.py
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('myapp.urls')),  # 嵌套应用路由
]
# myapp/urls.py
from django.urls import path
from . import views
urlpatterns = [
    path('', views.api_root),  # 处理 /api/
    path('users/', include('users.urls')),  # 嵌套用户模块路由
    path('posts/', include('posts.urls')),  # 嵌套帖子模块路由
]
# users/urls.py
from django.urls import path
from . import views
urlpatterns = [
    path('', views.UserList.as_view()),  # 处理 /api/users/
    path('<int:pk>/', views.UserDetail.as_view()),  # 处理 /api/users/1/
]

# project/urls.py
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/v1/', include('api.urls')),  # API 版本控制
]
# api/urls.py
urlpatterns = [
    path('', views.api_root),
    path('auth/', include('authentication.urls')),  # 认证模块
    path('products/', include('products.urls')),  # 产品模块
]
# products/urls.py
urlpatterns = [
    path('', views.ProductList.as_view()),
    path('<int:product_id>/', include([
        path('', views.ProductDetail.as_view()),  # 产品详情
        path('reviews/', include('reviews.urls')),  # 产品评论
        path('images/', include('images.urls')),  # 产品图片
    ])),
]
# reviews/urls.py
urlpatterns = [
    path('', views.ReviewList.as_view()),  # 产品评论列表
    path('<int:review_id>/', views.ReviewDetail.as_view()),  # 评论详情
]

# project/urls.py
urlpatterns = [
    path('api/', include(('myapp.urls', 'myapp'), namespace='api')),  # 命名空间
]
# myapp/urls.py
urlpatterns = [
    path('users/', include(('users.urls', 'users'), namespace='users')),
]
# 在模板或视图中使用反向解析
reverse('api:users:user_detail', args=[1])  # 解析为 /api/users/1/

# stores/urls.py
urlpatterns = [
    path('<int:store_id>/', include([
        path('', views.StoreDetail.as_view()),
        path('products/', include('products.urls')),  # 嵌套产品路由
    ])),
]
# products/urls.py
urlpatterns = [
    path('', views.StoreProductList.as_view()),  # 接收 store_id 参数
]
# views.py
class StoreProductList(generics.ListAPIView):
    def get_queryset(self):
        store_id = self.kwargs['store_id']  # 获取父路由参数
        return Product.objects.filter(store_id=store_id)

# project/urls.py
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('api.urls')),
]
# api/urls.py
urlpatterns = [
    path('auth/', include('authentication.urls')),  # 公开接口
    path('protected/', include('protected.urls')),  # 需要认证的接口
]
# protected/urls.py
from django.urls import path
from . import views
from django.contrib.auth.decorators import login_required
# 应用中间件到整个模块
urlpatterns = [
    path('dashboard/', login_required(views.DashboardView.as_view())),
    path('settings/', login_required(views.SettingsView.as_view())),
]

# project/urls.py
urlpatterns = [
    path('admin/', admin.site.urls),
    path('accounts/', include('accounts.urls')),
    path('staff/', include('staff.urls')),  # 仅员工可见
    path('customers/', include('customers.urls')),  # 仅客户可见
]
# staff/urls.py
from django.urls import path
from . import views
from django.contrib.admin.views.decorators import staff_member_required
urlpatterns = [
    path('', staff_member_required(views.StaffDashboard.as_view())),
    path('orders/', staff_member_required(views.OrderList.as_view())),
]

# dynamic_app/urls.py
from django.urls import path, include
import importlib
def get_dynamic_urls():
    urls = []
    for app_name in ['blog', 'shop', 'forum']:  # 动态应用列表
        try:
            app_urls = importlib.import_module(f'{app_name}.urls')
            urls.append(path(f'{app_name}/', include(app_urls)))
        except ImportError:
            pass
    return urls
urlpatterns = [
    path('', views.index),
    *get_dynamic_urls(),  # 动态添加子路由
]

# 错误示例：路径前缀冲突
urlpatterns = [
    path('products/', include('products.urls')),
    path('product-reviews/', include('reviews.urls')),  # 冲突！
]
# 解决方案：调整路径前缀
urlpatterns = [
    path('products/', include('products.urls')),
    path('reviews/', include('reviews.urls')),  # 改为更明确的前缀
]

# 反模式：过深的嵌套
/api/v1/users/1/profile/posts/2/comments/3/reply/
# 优化方案：扁平化设计
/api/v1/comments/3/reply/  # 通过 comment_id 关联

# 使用 re_path 和正则表达式提高匹配效率
from django.urls import re_path
urlpatterns = [
    # 匹配数字 ID，比 <int:id> 更高效
    re_path(r'^(?P<id>\d+)/$', views.ItemDetail.as_view()),
]

# 好的实践：明确的资源路径
/api/v1/users/1/posts/
# 避免：复杂的路径参数
/api/v1/user-posts?user_id=1

# project/urls.py
urlpatterns = [
    path('api/', include(('myapp.urls', 'myapp'), namespace='api')),
]
# 在视图中使用
reverse('api:user_list')

# project/urls.py
urlpatterns = [
    path('api/v1/', include('api_v1.urls')),
    path('api/v2/', include('api_v2.urls')),
]

from django.test import TestCase
from django.urls import reverse
class APIRoutesTestCase(TestCase):
    def test_user_list_route(self):
        response = self.client.get(reverse('api:users:list'))
        self.assertEqual(response.status_code, 200)