django-browsable-router 0.0.2

A Django Restframework router that can show APIViews and include other routers as navigable urls in the root view.

Django Browsable Router

pip install django-browsable-router

A Django Restframework router that can show APIViews and include other routers as navigable urls in the root view.

from browsable_router import APIRouter
from restframework.views import APIView
from restframework.viewsets import ViewSet


class TestView(APIView):
  ...

class TestViewSet(ViewSet):
  ...

router_1 = APIRouter()
router_1.format_root_view("other_routes", "These are under a different route.")
router_1.register(r"view-1", TestView.as_view(), "view_1")
router_1.register(r"view-2", TestViewSet.as_view(), "view_2")

router_2 = APIRouter()
router_2.register(r"view-3", TestView.as_view(), "view_3")
router_2.navigation_routes = {
    "route": router_1,
}

urlpatterns = [
    path("api/", include(router_2.urls))
]

Resulting browsable API:

#   API Root:
#   """API root."""
# 
#   "route":    "/api/route/"
#   "view-3":   "/api/view-3/"
# 
#   Other Routes:
#   """These are under a different route."""
# 
#   "view-1":    "/api/route/view-1/"
#   "view-2":    "/api/route/view-2/"