Documentation

# Router

Router class is intended for future registration of views including basic settings, such as prefix, app_name etc. Class works great with Django-Routify v0.2.7.1 and above.

Router initializer has the following parameters:

• prefix - URL prefix for each of the URLs (param optional);
• app_name - application name, the same that we doing in classic Django in urls.py file (param optional);
• Extra parameters:
  • auto_naming - automatic naming for each view (True by default);
  • auto_trailing_slash - automatically adds a trailing slash to each URL path (False by default);
  • dynamic_pattern (new in v0.3.3) - custom dynamic URL pattern for those people which is familiar with Go, NodeJS, Java, C#, PHP, Ruby patterns.
    Pattern examples:
    • '/books/<slug:book>' - default django pattern;
    • '/books/:book' - colon based pattern;
    • '/books/{book}' - curly brackets based pattern;
    • '/books/<book>' - angle brackets based pattern;

    Parameter is getting classes from django_routify package: ColonPattern, CurlyPattern and AnglePattern. By default it is default django pattern or Pattern class.

# Router decorators

Router has following decorators:

• @router.route(...) - for registration views with multiple HTTP methods;
• @router.get(...) (new in v0.3.4) - for registration views and wrap them into single GET method;
• @router.post(...) (new in v0.3.4) - for registration views and wrap them into single POST method;
• @router.put(...) (new in v0.3.4) - for registration views and wrap them into single PUT method;
• @router.patch(...) (new in v0.3.4) - for registration views and wrap them into single PATCH method;
• @router.delete(...) (new in v0.3.4) - for registration views and wrap them into single DELETE method.

Decorator @router.route has the following parameters:

• url_path* - URL path for current view (param required);
• Extra parameters:
  • name - name for current view (param optional);
  • methods (new in v0.2.8) - required HTTP methods for current view, is getting list with string methods ['GET', 'POST'] (param optional).

Decorators @router.get, @router.post, @router.put, @router.patch and @router.delete for single HTTP method wrapping has the following parameters:

• url_path* - URL path for current view (param required);
• Extra parameters:
  • name - name for current view (param optional);

# Including router function

For including router into urlpatterns Django-Routify has function called include_router which is getting router instance as a parameter.

# Dynamic URL patterns

In new v0.3.3 has been added custom dynamic patterns which can be setted during Router initializing in dynamic_pattern parameter.

It can be useful for those people which is familiar with dynamic URL patterns from Go, NodeJS, PHP etc.

Patterns are automatically getting types from annotations, or from 'parameters' attribute (example: {'book': str}) of class. By default if Pattern didn't found annotation of type it will be automatically setted to slug django type.

Django-Routify has the following dynamic URL pattern classes:

• '/users/<int:user_id>' - Pattern class;
• '/users/:user_id' - ColonPattern class;
• '/users/{user_id}' - CurlyPattern class;
• '/users/<user_id>' - AnglePattern class.

Example of usage custom patterns:

from django.views.generic import TemplateView

from django_routify import Router, CurlyPattern

router = Router(prefix='/users', dynamic_pattern=CurlyPattern)


@router.get('/{user_id}') # will be translated to '/<int:user_id>'
class User(TemplateView):
    parameters = {
        'user_id': int, # annotation for user_id
    }
    template_name = 'user.html'


print(router)
'''
Router(
    app_name:   ""
    url_prefix: "users"
    urls:       [<URLPattern '/<int:user_id>' [name='user']>]
)
'''