How can I list urlpatterns (endpoints) on Django?

by

If you want a list of all the urls in your project, first you need to install django-extensions

You can simply install using command.

pip install django-extensions

For more information related to package goto django-extensions

After that, add django_extensions in INSTALLED_APPS in your settings.py file like this:

INSTALLED_APPS = (
...
'django_extensions',
...
)

urls.py example:

from django.urls import path, include
from . import views
from . import health_views

urlpatterns = [
    path('get_url_info', views.get_url_func),
    path('health', health_views.service_health_check),
    path('service-session/status', views.service_session_status)
]

And then, run any of the command in your terminal

python manage.py show_urls

or

./manage.py show_urls

Sample output example based on config urls.py:

/get_url_info             django_app.views.get_url_func
/health                   django_app.health_views.service_health_check
/service-session/status   django_app.views.service_session_status

For more information you can check the documentation.

More Related Contents:

  1. Django – after login, redirect user to his custom page –> mysite.com/username
  2. Django : How can I see a list of urlpatterns?
  3. How to handle request.GET with multiple variables for the same parameter in Django
  4. View doesn’t return HttpResponse
  5. Hi I am new to Django Framework.getting error :No Module Named
  6. What is a NoReverseMatch error, and how do I fix it?
  7. Why does DEBUG=False setting make my django Static Files Access fail?
  8. Django optional url parameters
  9. How to use permission_required decorators on django class-based views
  10. Django get the static files URL in view
  11. Execute code in Django after response has been sent to the client
  12. django – get() returned more than one topic
  13. django: Purpose of django.utils.functional.SimpleLazyObject?
  14. Provide extra context to all views
  15. Can I call a view from within another view?
  16. Raw SQL queries in Django views
  17. Access kwargs from a URL in a Django template
  18. Example of Django Class-Based DeleteView
  19. django @login_required decorator for a superuser
  20. Redirect / return to same (previous) page in Django?
  21. How to get URL of current page, including parameters, in a template?
  22. Django – show loading message during long processing
  23. How to handle “matching query does not exist” when getting an object
  24. Getting Django admin url for an object
  25. What is the right way to validate if an object exists in a django view without returning 404?
  26. Django templates folders
  27. Forbidden (403) CSRF verification failed. Request aborted
  28. CSRF verification failed. Request aborted. on django
  29. Multiple form classes in django generic (class) views
  30. Proper way to handle multiple forms on one page in Django

Leave a Comment