document update

Author: eadwinCode

docs/docs/api_controller/index.md

@@ -14,6 +14,17 @@ So I designed APIController to extend Django-Ninja to class-based and have somet
 
 So if you enjoy class-based controls for building API, welcome aboard.
 
+
+## ControllerBase
+```python
+class ControllerBase(ABC):
+    ...
+```
+APIController decorates any class with `ControllerBase` if its not inheriting from it.
+
+!!!info
+    Inheriting from ControllerBase class gives you more IDE intellisense support.
+
 ## Quick Example
 Let's create an APIController to manage Django user model
 
@@ -23,7 +34,7 @@ from typing import List
 from ninja import ModelSchema
 from ninja_extra import (
     http_get, http_post, http_generic, http_delete,
-    api_controller, exceptions, status
+    api_controller, status, ControllerBase, pagination
 )
 from ninja_extra.controllers.response import Detail
 from django.contrib.auth import get_user_model
@@ -36,7 +47,7 @@ class UserSchema(ModelSchema):
 
 
 @api_controller('/users')
-class UsersController:
+class UsersController(ControllerBase):
     user_model = get_user_model()
 
     @http_post('')
@@ -47,69 +58,22 @@ class UsersController:
     @http_generic('/{int:user_id}', methods=['put', 'patch'], response=UserSchema)
     def update_user(self, user_id: int):
         """ Django Ninja will serialize Django ORM model to schema provided as `response`"""
-        user = self.user_model.objects.filter(id=user_id).first()
-        if user:
-            return user
-        raise exceptions.NotFound(f'User with id: `{user_id}` not found')
+        user = self.get_object_or_exception(self.user_model, id=user_id)
+        return user
 
     @http_delete('/{int:user_id}', response=Detail(status_code=status.HTTP_204_NO_CONTENT))
     def delete_user(self, user_id: int):
-        user = self.user_model.objects.filter(id=user_id).first()
-        if user:
-            user.delete()
-            return self.create_response('', status_code=status.HTTP_204_NO_CONTENT)
-        raise exceptions.NotFound(f'User with id: `{user_id}` not found')
+        user = self.get_object_or_exception(self.user_model, id=user_id)
+        user.delete()
+        return self.create_response('', status_code=status.HTTP_204_NO_CONTENT)
 
     @http_get('', response=List[UserSchema])
+    @pagination.paginate
     def list_user(self):
         return self.user_model.objects.all()
 
     @http_get('/{user_id}', response=UserSchema)
     def get_user_by_id(self, user_id: int):
-        user = self.user_model.objects.filter(id=user_id).first()
-        if user:
-            return user
-        raise exceptions.NotFound(f'User with id: `{user_id}` not found')
+        user = self.get_object_or_exception(self.user_model, id=user_id)
+        return user
 ```
-
-```python
-class ControllerBase:
-    ...
-```
-
-## **Model Properties**
--  ### **`permission_classes`**
-List of default permission classes defined in a controller `router`
-
--  ### **`auth`**
-List of default Authentication instances. As described in Django-Ninja [Authentication](https://django-ninja.rest-framework.com/tutorial/authentication/). default: `[]`
-
--  ### **`api`**
-Instance of NinjaExtraAPI at runtime. default:`None`
-
--  ### **`auto_import`**
-states whether APIController should added to auto_controller import list. default: `True`
-
--  ### **`get_router(cls)`**
-return controller to router instance if present and raises Exception is absent.
-
--  ### **`get_path_operations(cls)`**
-container `dict` of route definition which are pass to Django-Ninja at runtime
-
--  ### **`add_operation_from_route_function(cls, route_function: RouteFunction)`**
-A method overload for `add_api_operation` 
-
--  ### **`add_api_operation(cls, ...)`**
-Adds APIController route definitions to path operation
-
--  ### **`get_route_functions(cls)`**
-Gets all registered route in an APIController
-
--  ### **`get_permissions(self)`**
-Returns list of `permission_classes` instances
-
--  ### **`check_permissions(self)`**
-Check permission when route function is invoked
-
--  ### **`check_object_permissions(self, obj: Any)`**
-Checks object permissions. This is not automated. However, when called, it triggers all `permission_classes` `has_object_permission` function, just like in DRF