Class-based views (CBVs) are an alternative to function-based views. They allow you to reuse common logic, and group related views, while keeping the flexibility of function-based views.

To use a class-based view, subclass the method handler, and implement methods (get, post, put, patch, delete) for the class to correspond to each HTTP method you want to support.

For example:

class DummyView(HTTPMethodView):
    def get(self, request: Request):
        return text('I am get method')

    def put(self, request: Request):
        return text('I am put method')

If someone tries to use a non-implemented method, they will reveive a 405 response.

If you need any url params just include them in method signature, like you would for function-based views.

class DummyView(HTTPMethodView):
    def get(self, request: Request, my_param_here: str):
        return text(f"I am get method with {my_param_here}")

Next, you need to attach the view to the app or blueprint. You can do this in the exact same way as you would for a function-based view, except you should you use MyView.as_view() instead of my_view_handler.

app.add_route(DummyView.as_view(), "/<my_param_here>")

Alternatively, you can use the attach method:

DummyView.attach(app, "/<my_param_here>")

Or, at the time of subclassing:

class DummyView(HTTPMethodView, attach=app, uri="/<my_param_here>"):
    ...

To add a decorator, you can either:

1. Add it to the decorators list on the class, which will apply it to all methods on the class; or
2. Add it to the method directly, which will only apply it to that method.

class DummyView(HTTPMethodView):
    decorators = [my_decorator]
    ...

# or

class DummyView(HTTPMethodView):
    @my_decorator
    def get(self, request: Request):
        ...

One catch is that you need to be mindful that the call inside the decorator may need to account for the self argument, which is passed to the method as the first argument. Alternatively, you may want to also mark your method as staticmethod to avoid this.

Available attributes at the time of subclassing:

• attach (Optional[Union[Sanic, Blueprint]]): The app or blueprint to attach the view to.
• uri (str): The uri to attach the view to.
• methods (Iterable[str]): The HTTP methods to attach the view to. Defaults to {"GET"}.
• host (Optional[str]): The host to attach the view to.
• strict_slashes (Optional[bool]): Whether to add a redirect rule for the uri with a trailing slash.
• version (Optional[int]): The version to attach the view to.
• name (Optional[str]): The name to attach the view to.
• stream (bool): Whether the view is a stream handler.
• version_prefix (str): The prefix to use for the version. Defaults to "/v".