Skip to content

Update browsable-api.md #9509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auvipy merged 3 commits into from
Aug 27, 2024
Merged

Update browsable-api.md #9509

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54884a5
Update browsable-api.md
rafaelgramoschi Aug 21, 2024
bf77df6
Update docs/topics/browsable-api.md
auvipy Aug 27, 2024
e77eec0
Update docs/topics/browsable-api.md
auvipy Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/topics/browsable-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ By default, the API will return the format specified by the headers, which in th
To quickly add authentication to the browesable api, add a routes named `"login"` and `"logout"` under the namespace `"rest_framework"`. DRF provides default routes for this which you can add to your urlconf:

```python
from django.urls import include, re_path
Comment thread
auvipy marked this conversation as resolved.
Outdated

urlpatterns = [
# ...
url(r"^api-auth/", include("rest_framework.urls", namespace="rest_framework"))
re_path(r"^api-auth/", include("rest_framework.urls", namespace="rest_framework"))
Copy link
Copy Markdown
Contributor

@ulgens ulgens Aug 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't need to be a regex, path("api-auth/")... is just fine.

Copy link
Copy Markdown
Contributor Author

@rafaelgramoschi rafaelgramoschi Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little note about why i suggested re_path and not path (searching stackoverflow):
re_path() is similar to url() (both have regex support).
path() doesn't. (See Django docs)
But you are right, most of the docs use path()

Comment thread
auvipy marked this conversation as resolved.
Outdated
]
```

Expand Down
⚡