Optional parameters in django urls

Question

I want to achieve this in Django

List all items
Get only one item

def get(self, request, pk, format=None):
    if pk is not None:
         product = self.get_object(pk)
         serializer = ProductSerializer(product)
    else:
         products = Product.objects.all()
         serializer = ProductSerializer(products)
    return Response(serializer.data)

If pk is in URL take only one product if not take all list.

How can I achieve that in URL? What I'm doing is this

re_path(r"(?P<pk>\d+)", ProductView.as_view(), name="product"),

But 'pk' argument is required here. I don't want the pk to be required but optional.

Thanks in advance

willeM_ Van Onsem · Accepted Answer · 2022-02-28 19:13:13Z

6

Define two paths:

urlpatterns = [
    path('/', ProductView.as_view(), {'pk': None}, name='products'),
    path('<int:pk>/', ProductView.as_view(), name='product'),
    # …
]

The {'pk': None} part specifies what value to pass.

An alternative is to make the pk optional, so:

def get(self, request, pk=None, format=None):
    if pk is not None:
         product = self.get_object(pk)
         serializer = ProductSerializer(product)
    else:
         products = Product.objects.all()
         serializer = ProductSerializer(products, many=True)
    return Response(serializer.data)

then you make again two paths with:

urlpatterns = [
    path('/', ProductView.as_view(), name='products'),
    path('<int:pk>/', ProductView.as_view(), name='product'),
    # …
]

edited Feb 28, 2022 at 19:13

answered Feb 28, 2022 at 19:06

willeM_ Van Onsem

482k33 gold badges483 silver badges624 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

maca Over a year ago

When I add two paths, in swagger the APIs are being duplicated

willeM_ Van Onsem Over a year ago

@maca: the proper way to do this is therefore not to use get twice, but simply make a ModelViewSet, that will point to different methods...

willeM_ Van Onsem Over a year ago

@maca: see django-rest-framework.org/api-guide/viewsets By doing that, the two really point to different methods, hence with different documentation.

willeM_ Van Onsem Over a year ago

@maca: the routers then define several paths that will point to retrieve and get django-rest-framework.org/api-guide/routers

Collectives™ on Stack Overflow

Optional parameters in django urls

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related