DRF Router Cheat Sheet Dashboard

✅ SimpleRouter

A lightweight router that maps basic CRUD operations.

✅ DefaultRouter

Extends SimpleRouter with an API root and format suffixes.

🔗 Quick Comparison Table

🌐 SimpleRouter URL Patterns

🌐 DefaultRouter URL Patterns

🛠️ Key Router Methods

🔗 Comparison Table

💡 Pro Tips

• Disable trailing slashes: SimpleRouter(trailing_slash=False)
• Use UUID lookup: lookup_value_converter='uuid'
• Prefer DefaultRouter if you want an auto API root.
• Use @action for custom viewset logic like set_password().

💎 Third Party Helpers

🔧 Custom Router Examples

Build your own router when you need to break free of the default behavior.

1️⃣ Add a Global 'health-check' Route

from rest_framework.routers import DefaultRouter

class HealthCheckRouter(DefaultRouter):
    def get_urls(self):
        urls = super().get_urls()
        urls.append(path('health/', self.health_check, name='health-check'))
        return urls

    def health_check(self, request):
        return JsonResponse({'status': 'ok'})
        

2️⃣ No Trailing Slash Router

from rest_framework.routers import SimpleRouter

class NoSlashRouter(SimpleRouter):
    trailing_slash = ''
        

3️⃣ Custom Router with Global List-All

from rest_framework.routers import SimpleRouter

class ListAllRouter(SimpleRouter):
    def get_urls(self):
        urls = super().get_urls()
        urls.append(path('all/', self.list_all, name='list-all'))
        return urls

    def list_all(self, request):
        return Response({'detail': 'Custom list-all here'})
        

🚨 Common Pitfalls & How to Dodge Them

• Trailing Slash Confusion: DRF routers love adding slashes. Want none? Set trailing_slash = ''.
• Forgetting to call super().get_urls(): When you override, remember to pull in the parent URLs first!
• Over-customization: If you're rewriting 80% of a router, it might be better to use plain Django URL patterns instead.
• Nested URLs Need Nested Routers: Use drf-nested-routers instead of trying to hack it yourself.