From f07f48a5da0710ca807db372e0dabb045e8a380a Mon Sep 17 00:00:00 2001 From: Kamil Sampolski Date: Mon, 11 May 2020 12:01:00 +0200 Subject: [PATCH] Updating documentation / switching from url to path (#7237) * Update README.md We should use path instead of url in urlpatterns, * Update index.md We should use path instead of url in urlpatterns * Update README.md We should use path instead of url in urlpatterns --- README.md | 6 +++--- docs/index.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 41a344fcf..95020bb1d 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Startup up a new project like so... Now edit the `example/urls.py` module in your project: ```python -from django.conf.urls import url, include +from django.urls import path, include from django.contrib.auth.models import User from rest_framework import serializers, viewsets, routers @@ -114,8 +114,8 @@ router.register(r'users', UserViewSet) # Wire up our API using automatic URL routing. # Additionally, we include login URLs for the browsable API. urlpatterns = [ - url(r'^', include(router.urls)), - url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) + path('', include(router.urls)), + path('api-auth/', include('rest_framework.urls', namespace='rest_framework')) ] ``` diff --git a/docs/index.md b/docs/index.md index 65f907051..0e5f9dc7e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -148,7 +148,7 @@ Don't forget to make sure you've also added `rest_framework` to your `INSTALLED_ We're ready to create our API now. Here's our project's root `urls.py` module: - from django.conf.urls import url, include + from django.urls import path, include from django.contrib.auth.models import User from rest_framework import routers, serializers, viewsets @@ -170,8 +170,8 @@ Here's our project's root `urls.py` module: # Wire up our API using automatic URL routing. # Additionally, we include login URLs for the browsable API. urlpatterns = [ - url(r'^', include(router.urls)), - url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) + path('', include(router.urls)), + path('api-auth/', include('rest_framework.urls', namespace='rest_framework')) ] You can now open the API in your browser at [http://127.0.0.1:8000/](http://127.0.0.1:8000/), and view your new 'users' API. If you use the login control in the top right corner you'll also be able to add, create and delete users from the system.