Http method routing

[massover]

Code of Conduct

• I agree to follow Django's Code of Conduct

Feature Description

Add http method routing to urlpatterns

Problem

This doesn't work right now because the first url pattern will always resolve.

urlpatterns = [
    path('pet', views.pet_list_view),
    path('pet', views.pet_create_view),
]

I understand that we can solve this built in right now by routing on class methods.

urlpatterns = [
    path('pet', views.PetView.as_view())
]

Also, it can be solved functionally by making our own "routing" view:

urlpatterns = [
    path('pet', list_router(get=views.pet_list_view, post=views.pet_create_view),
]

It also seems like it would be nice if this "just worked" (or some other chosen syntax):

urlpatterns = [
    path('pet', views.pet_list_view, methods=['GET'],),
    path('pet', views.pet_create_view, methods=['POST']),
]

Request or proposal

request

Additional Details

forum thread

I found some prior tickets/conversation, but nothing really seems to suggest there's a blocker:

https://code.djangoproject.com/ticket/33780

https://code.djangoproject.com/ticket/2784

https://groups.google.com/g/django-developers/c/FQVrKXkYAig

I think this would be a nice addition to django especially for building some simple json apis. Looking at the UrlResolver code, it seems like not the type of code to try and implement as a "django app". Thoughts?

Implementation Suggestions

No response

[github-actions]

Thank you massover for sharing your idea! We have a lot of them so please be patient. You can see the current queue here.

Community instructions

For commenters, please use the emoji reactions on the issue to express support, and/or concern easily. Please use the comments to ask questions or contribute knowledge about the idea. It is unhelpful to post comments of "I'd love this" or "What's the state of this?"

Reaction Guide

• 👍 This is something I would use
• 👎 This is something that would cause problems for me or Django
• 😕 I’m indifferent to this
• 🎉 This is an easy win

[knyghty]

I like this but one question that will need to be answered is how to handle OPTIONS and HEAD.

[massover]

I like this but one question that will need to be answered is how to handle OPTIONS and HEAD.

generally, I'd think we want to preserve the behavior of function based views

For a function that accepts "get", I'd expect the url resolver to transparently also accept "head" (where django delegates the work of stripping the body to the webserver).

Unless I'm mistaken how function based views work in django right now, I don't think there's any practical behavior to preserve for options requests. If options is included as a method by the user, we can call the function callback. If options is missing, we can implement a default view callback like View.options, where the allowed methods come from the path definition. I'd say this is an improvement, but I suppose not necessary.