Skip to content

docs: warn against trailing slashes in router prefixes #9861

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

Open
0Nafi0 wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −0
Open

docs: warn against trailing slashes in router prefixes #9861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a52785
Update viewsets documentation with trailing slash warning
0Nafi0 Dec 31, 2025
06c840b
Merge pull request #1 from 0Nafi0/doc-trailing-slash-warning
0Nafi0 Dec 31, 2025
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
2 changes: 2 additions & 0 deletions docs/api-guide/viewsets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Typically we wouldn't do this, but would instead register the viewset with a rou

!!! warning
Do not use `.as_view()` with `@action` methods. It bypasses router setup and may ignore action settings like `permission_classes`. Use `DefaultRouter` for actions.
!!! warning
When registering viewsets, do not include a trailing slash in the prefix (e.g., use `r'users'`, not `r'users/'`). Unlike standard Django URL patterns, DRF routers append slashes automatically based on your trailing slash configuration.

Rather than writing your own viewsets, you'll often want to use the existing base classes that provide a default set of behavior. For example:

Expand Down
Loading