Documentation update

Author: eadwinCode

README.md

@@ -45,9 +45,10 @@ It is a combination of two subclass `TokenVerificationController` and `TokenObta
 If you wish to customize these routes, you can inherit from these controllers and change its implementation
 
 ```python
-from ninja_jwt.controller import TokenObtainPairController, router
+from ninja_extra import api_controller
+from ninja_jwt.controller import TokenObtainPairController
 
-@router('token', tags=['Auth']
+@api_controller('token', tags=['Auth'])
 class MyCustomController(TokenObtainPairController):
     """obtain_token and refresh_token only"
 ...

docs/docs/auth_integration.md

@@ -5,11 +5,11 @@ Authenticated user can be found in `request.user` or `request.auth`
 ### Route Authentication - Class Based
 
 ```python
-from ninja_extra import APIController, router, route
+from ninja_extra import api_controller, route
 from ninja_jwt.authentication import JWTAuth
 
-@router('')
-class MyController(APIController):
+@api_controller
+class MyController:
     @route.get('/some-endpoint', auth=JWTAuth())
     def some_endpoint(self):
         ...
@@ -19,7 +19,7 @@ class MyController(APIController):
 
 ```python
 from ninja import router
-from ninja_jwt import JWTAuth
+from ninja_jwt.authentication import JWTAuth
 
 router = router('')
 
@@ -39,18 +39,17 @@ from ninja.security import APIKeyHeader
 from ninja_jwt.authentication import JWTBaseAuthentication
 from ninja import router
 
-class ApiKey(APIKeyHeader):
+class ApiKey(APIKeyHeader, JWTBaseAuthentication):
     param_name = "X-API-Key"
 
     def authenticate(self, request, key):
-        if key == "supersecret":
-            return self.jwt_authenticate(request, token=key)
+        return self.jwt_authenticate(request, token=key)
 
 
 header_key = ApiKey()
 router = router('')
 
-@api.get("/headerkey", auth=header_key)
+@router.get("/headerkey", auth=header_key)
 def apikey(request):
     return f"Token = {request.auth}"
 

docs/docs/customizing_token_claims.md

@@ -6,7 +6,8 @@ its corresponding serializer. Here\'s an example :
 
 ```python
 from ninja_jwt.schema import TokenObtainPairSerializer
-from ninja_jwt.controller import TokenObtainPairController, router, route
+from ninja_jwt.controller import TokenObtainPairController
+from ninja_extra import api_controller, route
 from ninja_schema import Schema
 
 
@@ -27,10 +28,10 @@ class MyTokenObtainPairSchema(TokenObtainPairSerializer):
         out_dict.update(user=UserSchema.from_orm(self._user))
         return MyTokenObtainPairOutSchema(**out_dict)
 
-@router('/token', tags=['Auth'])
+@api_controller('/token', tags=['Auth'])
 class MyTokenObtainPairController(TokenObtainPairController):
     @route.post(
-        "/pair", response=schema.MyTokenObtainPairOutSchema, url_name="token_obtain_pair"
+        "/pair", response=MyTokenObtainPairOutSchema, url_name="token_obtain_pair"
     )
     def obtain_token(self, user_token: MyTokenObtainPairSchema):
         return user_token.output_schema()
@@ -50,7 +51,7 @@ from ninja_schema import Schema
 router = router('/token')
 
 @router.post(
-    "/pair", response=schema.MyTokenObtainPairOutSchema, url_name="token_obtain_pair"
+    "/pair", response=MyTokenObtainPairOutSchema, url_name="token_obtain_pair"
 )
 def obtain_token(self, user_token: MyTokenObtainPairSchema):
     return user_token.output_schema()

docs/docs/experimental_features.md

@@ -10,11 +10,12 @@ same token secret key. To use this feature, add the
 of the default `JWTAuth` backend) to the Django Ninja Extra route definition
 
 ```python
-from ninja_extra import APIController, router, route
+from ninja_extra import api_controller, route
 from ninja_jwt.authentication import JWTTokenUserAuth
 
-@router('')
-class MyController(APIController):
+
+@api_controller
+class MyController:
     @route.get('/some-endpoint', auth=JWTTokenUserAuth())
     def some_endpoint(self):
         pass

docs/docs/getting_started.md

@@ -34,9 +34,10 @@ It is a combination of two subclass `TokenVerificationController` and `TokenObta
 If you wish to customize these routes, you can inherit from these controllers and change its implementation
 
 ```python
-from ninja_jwt.controller import TokenObtainPairController, router
+from ninja_extra import api_controller
+from ninja_jwt.controller import TokenObtainPairController
 
-@router('token', tags=['Auth'])
+@api_controller('token', tags=['Auth'])
 class MyCustomController(TokenObtainPairController):
     """obtain_token and refresh_token only"
 ...

ninja_jwt/controller.py

@@ -1,36 +1,36 @@
-from ninja_extra import APIController, route, router
+from ninja_extra import api_controller, http_post
 from ninja_extra.permissions import AllowAny
 from ninja_schema import Schema
 
 from ninja_jwt import schema
 
 
-class TokenVerificationController(APIController):
+class TokenVerificationController:
     auto_import = False
 
-    @route.post("/verify", response={200: Schema}, url_name="token_verify")
+    @http_post("/verify", response={200: Schema}, url_name="token_verify")
     def verify_token(self, token: schema.TokenVerifySerializer):
         return {}
 
 
-class TokenBlackListController(APIController):
+class TokenBlackListController:
     auto_import = False
 
-    @route.post("/blacklist", response={200: Schema}, url_name="token_blacklist")
+    @http_post("/blacklist", response={200: Schema}, url_name="token_blacklist")
     def blacklist_token(self, refresh: schema.TokenBlacklistSerializer):
         return {}
 
 
-class TokenObtainPairController(APIController):
+class TokenObtainPairController:
     auto_import = False
 
-    @route.post(
+    @http_post(
         "/pair", response=schema.TokenObtainPairOutput, url_name="token_obtain_pair"
     )
     def obtain_token(self, user_token: schema.TokenObtainPairSerializer):
         return user_token.output_schema()
 
-    @route.post(
+    @http_post(
         "/refresh", response=schema.TokenRefreshSerializer, url_name="token_refresh"
     )
     def refresh_token(self, refresh_token: schema.TokenRefreshSchema):
@@ -41,15 +41,15 @@ def refresh_token(self, refresh_token: schema.TokenRefreshSchema):
 class TokenObtainSlidingController(TokenObtainPairController):
     auto_import = False
 
-    @route.post(
+    @http_post(
         "/sliding",
         response=schema.TokenObtainSlidingOutput,
         url_name="token_obtain_sliding",
     )
     def obtain_token(self, user_token: schema.TokenObtainSlidingSerializer):
         return user_token.output_schema()
 
-    @route.post(
+    @http_post(
         "/sliding/refresh",
         response=schema.TokenRefreshSlidingSerializer,
         url_name="token_refresh_sliding",
@@ -59,14 +59,14 @@ def refresh_token(self, refresh_token: schema.TokenRefreshSlidingSchema):
         return refresh
 
 
-@router("/token", permissions=[AllowAny], tags=["token"])
+@api_controller("/token", permissions=[AllowAny], tags=["token"])
 class NinjaJWTDefaultController(TokenVerificationController, TokenObtainPairController):
     """NinjaJWT Default controller for obtaining and refreshing tokens"""
 
     auto_import = False
 
 
-@router("/token", permissions=[AllowAny], tags=["token"])
+@api_controller("/token", permissions=[AllowAny], tags=["token"])
 class NinjaJWTSlidingController(
     TokenVerificationController, TokenObtainSlidingController
 ):

tests/urls.py

@@ -1,5 +1,5 @@
 from django.urls import path
-from ninja_extra import NinjaExtraAPI, permissions, router
+from ninja_extra import NinjaExtraAPI, api_controller, permissions
 
 from ninja_jwt.controller import (
     NinjaJWTDefaultController,
@@ -9,23 +9,25 @@
 
 from .views import TestAPIController
 
-sliding_router = router(
+TokenObtainSlidingController = api_controller(
     "/token",
     permissions=[permissions.AllowAny],
     tags=["token"],
-    controller=TokenObtainSlidingController,
-)
+)(TokenObtainSlidingController)
 
-blacklist_router = router(
+TokenBlackListController = api_controller(
     "/token",
     permissions=[permissions.AllowAny],
     tags=["token"],
-    controller=TokenBlackListController,
-)
+)(TokenBlackListController)
 
 api = NinjaExtraAPI(urls_namespace="jwt")
-api.add_controller_router(sliding_router, blacklist_router)
-api.register_controllers(NinjaJWTDefaultController, TestAPIController)
+api.register_controllers(
+    NinjaJWTDefaultController,
+    TestAPIController,
+    TokenObtainSlidingController,
+    TokenBlackListController,
+)
 
 
 urlpatterns = [

tests/views.py

@@ -1,10 +1,10 @@
-from ninja_extra import APIController, route, router
+from ninja_extra import api_controller, http_get
 
 from ninja_jwt import authentication
 
 
-@router("/test-view", auth=authentication.JWTAuth())
-class TestAPIController(APIController):
-    @route.get("/test", url_name="test_view")
+@api_controller("/test-view", auth=authentication.JWTAuth())
+class TestAPIController:
+    @http_get("/test", url_name="test_view")
     def test(self):
         return {"foo": "bar"}