proposal: DJA DefaultRouter #980

n2ygk · 2018-08-28T22:08:49Z

n2ygk
Aug 28, 2018
Maintainer

Proposal: `rest_framework_json_api.routers.DefaultRouter`

Current method of declaring `URLPatterns`

The current typical usage example is like this:

from rest_framework import routers

router = routers.DefaultRouter(trailing_slash=False)

router.register(r'blogs', BlogViewSet)
router.register(r'entries', EntryViewSet)

urlpatterns = [
    # basic collection and item URLs:
    url(r'^', include(router.urls)),
    # relationships URLs:
    url(r'^entries/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
        EntryRelationshipView.as_view(),
        name='entry-relationships'),
    url(r'^blogs/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
        BlogRelationshipView.as_view(),
        name='blog-relationships'),
   # related URLs:
    url(r'entries/(?P<entry_pk>[^/.]+)/blog',
        BlogViewSet.as_view({'get': 'retrieve'}),
        name='entry-blog'),
]

URLPatterns created by the Default Router

The above creates the following URLPatterns for router.register(r'blogs', BlogViewSet):

 00 = {URLPattern} <URLPattern '^blogs$' [name='blog-list']>
  default_args = {dict} {}
  lookup_str = {str} 'example.views.BlogViewSet'
  name = {str} 'blog-list'
  pattern = {RegexPattern} ^blogs$
   _is_endpoint = {bool} True
   _regex = {str} '^blogs$'
   _regex_dict = {dict} {}
   converters = {dict} {}
   name = {str} 'blog-list'
   regex = {SRE_Pattern} re.compile('^blogs$')
 01 = {URLPattern} <URLPattern '^blogs\.(?P<format>[a-z0-9]+)/?$' [name='blog-list']>
  default_args = {dict} {}
  lookup_str = {str} 'example.views.BlogViewSet'
  name = {str} 'blog-list'
  pattern = {RegexPattern} ^blogs\.(?P<format>[a-z0-9]+)/?$
   _is_endpoint = {bool} True
   _regex = {str} '^blogs\\.(?P<format>[a-z0-9]+)/?$'
   _regex_dict = {dict} {}
   converters = {dict} {}
   name = {str} 'blog-list'
   regex = {SRE_Pattern} re.compile('^blogs\\.(?P<format>[a-z0-9]+)/?$')
 02 = {URLPattern} <URLPattern '^blogs/(?P<pk>[^/.]+)$' [name='blog-detail']>
  default_args = {dict} {}
  lookup_str = {str} 'example.views.BlogViewSet'
  name = {str} 'blog-detail'
  pattern = {RegexPattern} ^blogs/(?P<pk>[^/.]+)$
   _is_endpoint = {bool} True
   _regex = {str} '^blogs/(?P<pk>[^/.]+)$'
   _regex_dict = {dict} {}
   converters = {dict} {}
   name = {str} 'blog-detail'
   regex = {SRE_Pattern} re.compile('^blogs/(?P<pk>[^/.]+)$')
 03 = {URLPattern} <URLPattern '^blogs/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$' [name='blog-detail']>
  default_args = {dict} {}
  lookup_str = {str} 'example.views.BlogViewSet'
  name = {str} 'blog-detail'
  pattern = {RegexPattern} ^blogs/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$

along with an api-root view that lists the available registry entries. This is a nice feature.

Drawbacks of the current method

Relationships & related URLs follow a standard pattern yet have to be "manually" declared separately. This is hard to do, error prone and just plain annoying.
We might not need the .<format> flavor of each ViewSet. (Not a huge concern.)

Proposed: `rest_framework_json_api.DefaultRouter`

Create a DJA DefaultRouter that extends DRF's DefaultRouter:

Add URLPatterns for relationships and their RelationshipView. This seems pretty straightforward. Just add another argument to DefaultRouter.register() (or apply a default naming pattern) to add the RelationshipView.
Add URLPatterns for related links. This is a bit harder as each related link has to be enumerated (link name and ViewSet).

The goal would be to have a URLPatterns that looks like this:

from rest_framework_json_api import routers

router = routers.DefaultRouter(trailing_slash=False)

router.register(r'blogs', BlogViewSet, BlogRelationshipView)
router.register(r'entries', EntryViewSet, EntryRelationshipView, ??related stuff here??)

urlpatterns = [
    url(r'^', include(router.urls)),
]

For how to do the "related stuff here" take a look at @Anton-Shutik's approach in #451

sliverc · 2018-08-29T08:15:30Z

sliverc
Aug 29, 2018
Maintainer

I like the idea 👍

I think to register related urls as implemented in #451 will be fairly straight forward. With RelationshipView is going to be a bit harder but playing around with implementation might lead to a good solution. Only thing which also need to be considered is to implement a json api specific SimpleRouter and DefaultRouter as both might be used.

0 replies

n2ygk · 2018-08-31T22:04:23Z

n2ygk
Aug 31, 2018
Maintainer Author

I've "moved" this comment thread about naming to it's own issue: #471

0 replies

auvipy · 2019-11-13T06:20:19Z

auvipy
Nov 13, 2019

might be related encode/django-rest-framework#6789

0 replies

platinumazure · 2020-12-27T22:28:07Z

platinumazure
Dec 27, 2020

Is this something the project is still interested in? When I started using DJA, I found it a little frustrating and unintuitive that we couldn't just "automatically" include the relationship and related resource routes.

If a PR is likely to be accepted, I could look into this within the next 1-2 weeks.

0 replies

auvipy · 2020-12-28T05:26:19Z

auvipy
Dec 28, 2020

Is this something the project is still interested in? When I started using DJA, I found it a little frustrating and unintuitive that we couldn't just "automatically" include the relationship and related resource routes.

If a PR is likely to be accepted, I could look into this within the next 1-2 weeks.

A PR is certainly welcome in this regard

0 replies

sliverc · 2020-12-28T06:33:56Z

sliverc
Dec 28, 2020
Maintainer

@platinumazure I don't think this will be straight forward but I would love to see this implemented as well.

0 replies

sliverc · 2021-09-23T17:31:02Z

sliverc
Sep 23, 2021
Maintainer

This is a great idea which we should investigate further. Especially thinking about how the RelatedMixin could be replaced with a router as the current implementation is confusing especially when it comes to permissions and lacks feature such as filter support. See also #916

I do think though we should talk this through more about what a proper design of a DJA router would be and of such a discussion or proof of concept in that regard extract specific issues. Therefore converting this issue to a discussion.

0 replies

axieum · 2023-02-06T05:32:57Z

axieum
Feb 6, 2023

Adding support for the built-in DRF routers would 100% clean up all the URL definition files and make DJA consistent with DRF. 👍

proposal: DJA DefaultRouter #980

Uh oh!

Uh oh!

n2ygk Aug 28, 2018 Maintainer

Proposal: rest_framework_json_api.routers.DefaultRouter

Current method of declaring URLPatterns

URLPatterns created by the Default Router

Drawbacks of the current method

Proposed: rest_framework_json_api.DefaultRouter

Replies: 12 comments

Uh oh!

sliverc Aug 29, 2018 Maintainer

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

Uh oh!

n2ygk Aug 31, 2018 Maintainer Author

Uh oh!

Uh oh!

auvipy Nov 13, 2019

Uh oh!

platinumazure Dec 27, 2020

Uh oh!

auvipy Dec 28, 2020

Uh oh!

sliverc Dec 28, 2020 Maintainer

Uh oh!

sliverc Sep 23, 2021 Maintainer

Uh oh!

axieum Feb 6, 2023

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

n2ygk
Aug 28, 2018
Maintainer

Proposal: `rest_framework_json_api.routers.DefaultRouter`

Current method of declaring `URLPatterns`

Proposed: `rest_framework_json_api.DefaultRouter`

sliverc
Aug 29, 2018
Maintainer

n2ygk
Aug 31, 2018
Maintainer Author

auvipy
Nov 13, 2019

platinumazure
Dec 27, 2020

auvipy
Dec 28, 2020

sliverc
Dec 28, 2020
Maintainer

sliverc
Sep 23, 2021
Maintainer

axieum
Feb 6, 2023