drf 路由组件
自定义路由(原始方法)
urlpatterns = [
url(r'^books/$', views.BookView.as_view()),
url(r'^books/(?P<pk>\d+)$', views.BookDetailView.as_view()),
]
半自动路由(视图类继承ModelViewSet)
urlpatterns = [
url(r'^publish/$', views.PublishView.as_view({'get':'list','post':'create'})),
url(r'^publish/(?P<pk>\d+)/$', views.PublishView.as_view({'get':'retrieve','put':'update','delete':'destroy'})),
]
路由Routers
对于视图集ViewSet,我们除了可以自己手动指明请求方式与动作action之间的对应关系外,还可以使用Routers来帮助我们快速实现路由信息。
REST framework提供了两个router
- SimpleRouter
- DefaultRouter
register(prefix, viewset, base_name)
- prefix 该视图集的路由前缀
- viewset 视图集
- base_name 路由别名的前缀
使用方法:
1. 导入routers模块
from rest_framework import routers
2. 实例化得到对象
# routers.DefaultRouter 生成的路由更多
router = routers.SimpleRouter()
3. 注册
router.register('books', views.Book4ViewSet)
4. 生成路由,加入到原路由中
urlpatterns += router.urls
或者
urlpatterns = [
...
url(r'^', include(router.urls))
]
routers.SimpleRouter()
routers.DefaultRouter()
^books/$ [name='book-list']
^books/(?P<pk>[^/.]+)/$ [name='book-detail'] 这两条跟simple一样
^$ [name='api-root'] 根,根路径会显示出所有可以访问的地址
^\.(?P<format>[a-z0-9]+)/?$ [name='api-root']
^books\.(?P<format>[a-z0-9]+)/?$ [name='book-list'] 获取json格式数据: http://127.0.0.1:8000/books.json
^books/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$ [name='book-detail'] 获取json格式数据: http://127.0.0.1:8000/books/1.json
action的使用
action的作用: 为了给继承自ModelViewSet的视图类中定义的函数也添加路由
使用方法:
@action(methods=['get','post'], detail=True)
def get1(self,request,pk):
print(pk)
book = self.get_queryset()[:2]
ser = self.get_serializer(book, many=True)
return Response(ser.data)
# action装饰器,放在被装饰的函数上方,method:请求方式,detail:是否带pk
参数解析:
- methods: 声明该action对应的请求方式,列表传递
- detail: 声明该action的路径是否与单一资源对应,
- True 表示路径格式是
xxx/<pk>/action方法名/
- False 表示路径格式是
xxx/action方法名/
- True 表示路径格式是