rest_framework.routers.DefaultRouter

class documentation

class DefaultRouter(SimpleRouter): (source)

View In Hierarchy

The default router extends the SimpleRouter, but also adds in a default API root view, and adds format suffix patterns to the URLs.

Method __init__ Undocumented
Method get_api_root_view Return a basic root view.
Method get_urls Generate the list of URL patterns, including a default root view for the API, and appending `.json` style format suffixes.
Class Variable default_schema_renderers Undocumented
Class Variable include_format_suffixes Undocumented
Class Variable include_root_view Undocumented
Class Variable root_view_name Undocumented
Instance Variable root_renderers Undocumented

Inherited from SimpleRouter:

Method get_default_basename If `basename` is not specified, attempt to automatically determine it from the viewset.
Method get_lookup_regex Given a viewset, return the portion of URL regex that is used to match against a single instance.
Method get_method_map Given a viewset, and a mapping of http methods to actions, return a new mapping which only includes any mappings that are actually implemented by the viewset.
Method get_routes Augment `self.routes` with any dynamically generated routes.
Class Variable routes Undocumented
Instance Variable trailing_slash Undocumented
Method _get_dynamic_route Undocumented

Inherited from BaseRouter (via SimpleRouter):

Method register Undocumented
Instance Variable registry Undocumented
Property urls Undocumented
def __init__(self, *args, **kwargs): (source)
overrides rest_framework.routers.SimpleRouter.__init__

Undocumented

def get_api_root_view(self, api_urls=None): (source)

Return a basic root view.

def get_urls(self): (source)
overrides rest_framework.routers.SimpleRouter.get_urls

Generate the list of URL patterns, including a default root view for the API, and appending `.json` style format suffixes.

default_schema_renderers = (source)

Undocumented

include_format_suffixes: bool = (source)

Undocumented

include_root_view: bool = (source)

Undocumented

root_view_name: str = (source)

Undocumented

root_renderers = (source)

Undocumented