Update tutorial

YegorDB · Jun 13, 2023 · 870be46 · 870be46
1 parent bee43ec
commit 870be46
Showing 1 changed file with 41 additions and 10 deletions.
diff --git a/tutorial/drf/README.md b/tutorial/drf/README.md
@@ -1,7 +1,11 @@
 # Django REST framework middlewares tutorial
 
 - [DRFAuthTokenMiddleware](#drfauthtokenmiddleware)
+- [QueryStringDRFAuthTokenMiddleware](#querystringdrfauthtokenmiddleware)
+- [DRFAuthTokenMiddlewareStack](#drfauthtokenmiddlewarestack)
 - [SimpleJWTAuthTokenMiddleware](#simplejwtauthtokenmiddleware)
+- [QueryStringSimpleJWTAuthTokenMiddleware](#queryStringsimplejwtauthtokenmiddleware)
+- [SimpleJWTAuthTokenMiddlewareStack](#simplejwtauthtokenmiddlewarestack)
 
 
 ## DRFAuthTokenMiddleware
@@ -100,25 +104,30 @@ application = ProtocolTypeRouter({
 ```
 
 
-## SimpleJWTAuthTokenMiddleware
+## QueryStringDRFAuthTokenMiddleware
 
-> [Simple JWT](https://django-rest-framework-simplejwt.readthedocs.io/en/latest/index.html) middleware
+> Django REST framework auth token middleware with query string token
 
 ### Usage example
 
-> SimpleJWTAuthTokenMiddleware could be used directly or behind other auth middlewares or middleware stacks.
+> Like DRFAuthTokenMiddleware QueryStringDRFAuthTokenMiddleware could be used directly or behind other auth middlewares or middleware stacks.
 
-Direct usage
+
+## DRFAuthTokenMiddlewareStack
+
+> Combines DRFAuthTokenMiddleware and QueryStringDRFAuthTokenMiddleware
+
+### Usage example
 
 ```python
 from channels.routing import ProtocolTypeRouter, URLRouter
 
-from channels_auth_token_middlewares.middleware import SimpleJWTAuthTokenMiddleware
+from channels_auth_token_middlewares.middleware import DRFAuthTokenMiddlewareStack
 
 
 application = ProtocolTypeRouter({
 
-    "websocket": SimpleJWTAuthTokenMiddleware(
+    "websocket": DRFAuthTokenMiddlewareStack(
         URLRouter([
             # app paths
         ]),
@@ -127,22 +136,44 @@ application = ProtocolTypeRouter({
 })
 ```
 
-With AuthMiddlewareStack
+Same example without stack
 
 ```python
 from channels.routing import ProtocolTypeRouter, URLRouter
-from channels.auth import AuthMiddlewareStack
 
-from channels_auth_token_middlewares.middleware import SimpleJWTAuthTokenMiddleware
+from channels_auth_token_middlewares.middleware import DRFAuthTokenMiddleware, QueryStringDRFAuthTokenMiddleware
 
 
 application = ProtocolTypeRouter({
 
-    "websocket": AuthMiddlewareStack(SimpleJWTAuthTokenMiddleware(
+    "websocket": DRFAuthTokenMiddleware(QueryStringDRFAuthTokenMiddleware(
         URLRouter([
             # app paths
         ]),
     )),
 
 })
 ```
+
+
+## SimpleJWTAuthTokenMiddleware
+
+> [Simple JWT](https://django-rest-framework-simplejwt.readthedocs.io/en/latest/index.html) middleware
+
+### Usage example
+
+> Like DRFAuthTokenMiddleware SimpleJWTAuthTokenMiddleware could be used directly or behind other auth middlewares or middleware stacks.
+
+
+## QueryStringSimpleJWTAuthTokenMiddleware
+
+> Simple JWT auth token middleware with query string token
+
+### Usage example
+
+> Like DRFAuthTokenMiddleware QueryStringSimpleJWTAuthTokenMiddleware could be used directly or behind other auth middlewares or middleware stacks.
+
+
+## SimpleJWTAuthTokenMiddlewareStack
+
+> Like DRFAuthTokenMiddlewareStack but combines SimpleJWTAuthTokenMiddleware and QueryStringSimpleJWTAuthTokenMiddleware