Added a section in docs about decorators #67
Conversation
JWT and authorization can be a tough topic for beginners to break into. While the documentation clearly outlines the starting places, it has left out the portion for decorators and decorating the to-be-protected views.
docs/index.md
Outdated
| @@ -97,6 +97,21 @@ Now in order to access protected api urls you must include the `Authorization: B | |||
| $ curl -H "Authorization: Bearer <your_token>" http://localhost:8000/protected-url/ | |||
| ``` | |||
|
|
|||
| In addition to adding the Authorization: Bearer in your requests, make sure that you have decorated your views properly. For this, import the JSONWebTokenAuthentication authenticaion class from rest_framework_jwt.authentication | |||
There was a problem hiding this comment.
JSONWebTokenAuthentication authenticaion
"authenticaion" is misspelled, and the JSONWebTokenAuthentication can be styled as JSONWebTokenAuthentication
make sure that you have decorated your views properly
I suggest you point out that this only applies to function based views. The class based views include this by overriding the authentication_classes class attribute. Feel free to add an example for the class based views as well.
There was a problem hiding this comment.
Sure! I will modify the PR according to your suggestions!
|
Closes #66 |
Fixed spelling error in previous PR and added a section about class-based views in the doc.
|
I just made the changes. Could you review the changes? Thanks! |
Codecov Report
@@ Coverage Diff @@
## master #67 +/- ##
=======================================
Coverage 98.12% 98.12%
=======================================
Files 19 19
Lines 481 481
Branches 45 45
=======================================
Hits 472 472
Misses 7 7
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
JWT and authorization can be a tough topic for beginners to break into. While the documentation clearly outlines the starting places, it has left out the portion for decorators and decorating the to-be-protected views.