Bao gồm các phương thức list_route trong gốc API của khung công tác REST của Django

Question

Tôi đang sử dụng khung công tác REST Django, và tôi đã thiết lập chế độ xem với phương thức tuyến danh sách bổ sung. Làm thế nào tôi có thể nhận được URL của phương thức đó trong trang gốc API?

Dưới đây là một phiên bản đơn giản của bộ quan điểm của tôi:

class BookViewSet(viewsets.ReadOnlyModelViewSet): 
    queryset = Book.objects.all() 
    serializer_class = BookSerializer 
    permission_classes = (permissions.IsAuthenticated,) 

    @list_route(methods=['get']) 
    def featured(self, request): 
     queryset = self.filter_queryset(self.get_queryset()).filter(featured=True) 

     page = self.paginate_queryset(queryset) 
     if page is not None: 
      serializer = self.get_serializer(page, many=True) 
      return self.get_paginated_response(serializer.data) 

     serializer = self.get_serializer(queryset, many=True) 
     return Response(serializer.data) 

tôi đăng ký xem thiết lập trong urls.py:

router = DefaultRouter() 
router.register('books', BookViewSet) 
urlpatterns = patterns(
    url(r'^api/', include(router.urls), name='api_home'), 
    #... 
    ) 

URL cho books/featured được định tuyến đúng, nhưng khi tôi đi đến http://localhost:8000/api, Tôi chỉ thấy điều này:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept 
Allow: GET, HEAD, OPTIONS 

{ 
    "books": "http://localhost:8000/api/books/" 
} 

Làm thế nào tôi có thể nhận được một mục nhập cho một cái gì đó như thế này?

"book-featured-list": "http://localhost:8000/api/books/featured" 

Answer 1

Bạn có thể cố gắng để kế thừa từ DefaultRouter mà có trách nhiệm xem gốc api và xác định lại phương pháp get_api_root_view.

class MyRouter(routers.DefaultRouter): 
    def get_api_root_view(self): 
     """ 
     Return a view to use as the API root. 
     """ 
     api_root_dict = OrderedDict() 
     list_name = self.routes[0].name 
     for prefix, viewset, basename in self.registry: 
      api_root_dict[prefix] = list_name.format(basename=basename) 

     class APIRoot(views.APIView): 
      _ignore_model_permissions = True 

      def get(self, request, *args, **kwargs): 
       ret = OrderedDict() 
       namespace = request.resolver_match.namespace 
       for key, url_name in api_root_dict.items(): 
        if namespace: 
         url_name = namespace + ':' + url_name 
        try: 
         ret[key] = reverse(
          url_name, 
          args=args, 
          kwargs=kwargs, 
          request=request, 
          format=kwargs.get('format', None) 
         ) 
        except NoReverseMatch: 
         # Don't bail out if eg. no list routes exist, only detail routes. 
         continue 

       ret['book-featured-list'] = '%s%s' % (ret['books'], 'featured/') 

       return Response(ret) 

     return APIRoot.as_view() 

P.S. xin lỗi, không thấy bình luận của bạn trước khi tôi đăng câu trả lời

Answer 2

Bạn có thể thử với, đặt dưới url mẫu của bạn. url của bạn sẽ như thế này:

http://localhost:8000/api/books/ 

from rest_framework.urlpatterns import format_suffix_patterns 

urlpatterns = format_suffix_patterns(urlpatterns) 

Answer 3

Bạn có thể cài đặt gói django-nghỉ ngơi-vênh vang, chỉ cần làm theo ở đây: https://github.com/marcgibbons/django-rest-swagger

Đó là mạnh hơn trang danh sách api DRF của. Nó sẽ liệt kê tất cả các apis còn lại (bao gồm list_route/detail_route apis) cho các mô đun của bạn, và bạn cũng có thể thực hiện một số kiểm tra api (CRUD) trên trang.

Answer 4

tôi sử dụng giải pháp này dựa trên câu trả lời của likeon:

class MyRouter(routers.DefaultRouter): 
    def get_api_root_view(self, api_urls=None): 
     api_root_dict = OrderedDict() 
     list_name = self.routes[0].name 
     for prefix, viewset, basename in self.registry: 
      api_root_dict[prefix] = list_name.format(basename=basename) 

     api_root_dict['books/featured'] = 'book-featured' 

     return self.APIRootView.as_view(api_root_dict=api_root_dict)