By default the URLs created by`SimpleRouter` uses_regexs_ to build urls. This behavior can be modified by setting the`use_regex_path` argument to`False` when instantiating the router, in this case[path converters][path-convertes-topic-reference] are used. For example:

**Note**:`use_regex_path=False` only works with Django 2.x or above, since this feature was introduced in 2.0.0. See[release note][simplified-routing-release-note]

This router is similar to`SimpleRouter` as above, but additionally includes a default API root view, that returns a response containing hyperlinks to all the list views. It also generates routes for optional`.json` style format suffixes.

[drf-extensions-customizable-endpoint-names]:https://chibisov.github.io/drf-extensions/docs/#controller-endpoint-name

[url-namespace-docs]:https://docs.djangoproject.com/en/1.11/topics/http/urls/#url-namespaces

[include-api-reference]:https://docs.djangoproject.com/en/2.0/ref/urls/#include

[simplified-routing-release-note]:https://docs.djangoproject.com/en/2.0/releases/2.0/#simplified-url-routing-syntax

[path-convertes-topic-reference]:https://docs.djangoproject.com/en/2.0/topics/http/urls/#path-converters

fromcollectionsimportOrderedDict,namedtuple

fromdjango.core.exceptionsimportImproperlyConfigured

fromdjango.urlsimportNoReverseMatch,re_path

fromdjango.urlsimportNoReverseMatch,path,re_path

fromrest_framework.responseimportResponse

),

]

def__init__(self,trailing_slash=True):

def__init__(self,trailing_slash=True,use_regex_path=True):

self.trailing_slash='/'iftrailing_slashelse''

ifuse_regex_path:

self._base_regex='(?P<{lookup_prefix}{lookup_url_kwarg}>{lookup_value})'

self._default_regex='[^/.]+'

self._url_conf=re_path

else:

self._base_regex='<{lookup_value}:{lookup_prefix}{lookup_url_kwarg}>'

self._default_regex='path'

self._url_conf=path

_routes= []

forrouteinself.routes:

url_param=route.url

ifurl_param[0]=='^':

url_param=url_param[1:]

ifurl_param[-1]=='$':

url_param=url_param[:-1]

_routes.append(route._replace(url=url_param))

self.routes=_routes

super().__init__()

defget_default_basename(self,viewset):

lookup_field=getattr(viewset,'lookup_field','pk')

lookup_url_kwarg=getattr(viewset,'lookup_url_kwarg',None)orlookup_field

lookup_value=getattr(viewset,'lookup_value_regex','[^/.]+')

returnbase_regex.format(

lookup_value=getattr(viewset,'lookup_value_regex',self._default_regex)

returnself._base_regex.format(

lookup_prefix=lookup_prefix,

lookup_url_kwarg=lookup_url_kwarg,

ifnotprefixandregex[:2]=='^/':

regex='^'+regex[2:]

ifnotprefix:

ifself._url_confispath:

ifregex[0]=='/':

regex=regex[1:]

elifregex[:2]=='^/':

regex='^'+regex[2:]

initkwargs=route.initkwargs.copy()

initkwargs.update({

view=viewset.as_view(mapping,**initkwargs)

name=route.name.format(basename=basename)

ret.append(re_path(regex,view,name=name))

ret.append(self._url_conf(regex,view,name=name))

fromrest_framework.decoratorsimportaction

fromrest_framework.responseimportResponse

fromrest_framework.routersimportDefaultRouter,SimpleRouter

fromrest_framework.testimportAPIRequestFactory,URLPatternsTestCase

fromrest_framework.testimport (

APIClient,APIRequestFactory,URLPatternsTestCase

)

fromrest_framework.utilsimportjson

factory=APIRequestFactory()

returnResponse({'pk':pk,'kwarg':kwarg})

classUrlPathViewSet(viewsets.ViewSet):

defurl_path_list(self,request,*args,**kwargs):

kwarg=self.kwargs.get('kwarg','')

returnResponse({'kwarg':kwarg})

defurl_path_detail(self,request,*args,**kwargs):

pk=self.kwargs.get('pk','')

kwarg=self.kwargs.get('kwarg','')

returnResponse({'pk':pk,'kwarg':kwarg})

notes_router=SimpleRouter()

notes_router.register(r'notes',NoteViewSet)

notes_path_router=SimpleRouter(use_regex_path=False)

notes_path_router.register('notes',NoteViewSet)

kwarged_notes_router=SimpleRouter()

kwarged_notes_router.register(r'notes',KWargedNoteViewSet)

regex_url_path_router=SimpleRouter()

regex_url_path_router.register(r'',RegexUrlPathViewSet,basename='regex')

url_path_router=SimpleRouter(use_regex_path=False)

url_path_router.register('',UrlPathViewSet,basename='path')

classBasicViewSet(viewsets.ViewSet):

deflist(self,request,*args,**kwargs):

assertjson.loads(response.content.decode())== {'pk':pk,'kwarg':kwarg}

classTestUrlPath(URLPatternsTestCase,TestCase):

urlpatterns= [

path('path/',include(url_path_router.urls)),

path('example/',include(notes_path_router.urls))

]

defsetUp(self):

RouterTestModel.objects.create(uuid='123',text='foo bar')

RouterTestModel.objects.create(uuid='a b',text='baz qux')

deftest_create(self):

new_note= {

'uuid':'foo',

'text':'example'

}

response=self.client.post('/example/notes/',data=new_note)

assertresponse.status_code==201

assertresponse['location']=='http://testserver/example/notes/foo/'

assertresponse.data== {"url":"http://testserver/example/notes/foo/","uuid":"foo","text":"example"}

assertRouterTestModel.objects.filter(uuid='foo').exists()

deftest_retrieve(self):

response=self.client.get('/example/notes/123/')

assertresponse.status_code==200

assertresponse.data== {"url":"http://testserver/example/notes/123/","uuid":"123","text":"foo bar"}

deftest_list(self):

response=self.client.get('/example/notes/')

assertresponse.status_code==200

assertresponse.data== [

{"url":"http://testserver/example/notes/123/","uuid":"123","text":"foo bar"},

{"url":"http://testserver/example/notes/a%20b/","uuid":"a b","text":"baz qux"},

]

deftest_update(self):

updated_note= {

'text':'foo bar example'

}

response=self.client.patch('/example/notes/123/',data=updated_note)

assertresponse.status_code==200

assertresponse.data== {"url":"http://testserver/example/notes/123/","uuid":"123","text":"foo bar example"}

deftest_delete(self):

response=self.client.delete('/example/notes/123/')

assertresponse.status_code==204

assertnotRouterTestModel.objects.filter(uuid='123').exists()

deftest_list_extra_action(self):

response=self.client.get('/path/list/{}/'.format(kwarg))

assertresponse.status_code==200

assertjson.loads(response.content.decode())== {'kwarg':kwarg}

deftest_detail_extra_action(self):

response=self.client.get('/path/{}/detail/{}/'.format(pk,kwarg))

assertresponse.status_code==200

assertjson.loads(response.content.decode())== {'pk':pk,'kwarg':kwarg}

classTestViewInitkwargs(URLPatternsTestCase,TestCase):

urlpatterns= [

path('example/',include(notes_router.urls)),