Tivix/django-rest-auth
1
1
Fork 0
mirror of https://github.com/Tivix/django-rest-auth.git synced 2024-11-14 05:06:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Changed ul markdown elements in README.md.

Browse Source
This commit is contained in:
Silin Na 2014-04-30 16:25:38 -07:00
parent 60a0dc8f54
commit c0da444b06
1 changed files with 36 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -20,7 +20,7 @@ Installation
> >
> djangorestframework>=2.3.13 > djangorestframework>=2.3.13
2. Install this package. 2. Install this package
3. Add rest_auth app to INSTALLED\_APPS in your django settings.py 3. Add rest_auth app to INSTALLED\_APPS in your django settings.py
@ -29,7 +29,7 @@ Installation
'rest_auth', 'rest_auth',
) )
4. This project depends on django-rest-framework library, therefore the following REST_FRAMEWORK settings needs to be entered in your Django settings.py:: 4. This project depends on django-rest-framework library, therefore the following REST_FRAMEWORK settings needs to be entered in your Django settings.py
REST_FRAMEWORK = { REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': ( 'DEFAULT_AUTHENTICATION_CLASSES': (
@ -41,7 +41,7 @@ Installation
) )
} }
5. Lastly, this project accepts the following Django setting values. You can set the UserProfile model and/or create your own REST registration backend for django-registration. 5. Lastly, this project accepts the following Django setting values. You can set the UserProfile model and/or create your own REST registration backend for django-registration
REST_REGISTRATION_BACKEND = 'rest_auth.backends.rest_registration.RESTRegistrationView' REST_REGISTRATION_BACKEND = 'rest_auth.backends.rest_registration.RESTRegistrationView'
REST_PROFILE_MODULE = 'accounts.UserProfile' REST_PROFILE_MODULE = 'accounts.UserProfile'
@ -51,37 +51,41 @@ Installation
API endpoints without Authentication API endpoints without Authentication
------------------------------------ ------------------------------------
1. /rest\_accounts/register/ - POST 1. /rest\_accounts/register/
- POST
- username - username
- password - password
- email - email
- first\_name - first\_name
- last\_name - last\_name
2. /rest\_accounts/password/reset/ - POST 2. /rest\_accounts/password/reset/
- POST
- email - email
3. /rest\_accounts/password/reset/confirm/{uidb64}/{token}/ - POST 3. /rest\_accounts/password/reset/confirm/{uidb64}/{token}/
- POST
- new\_password1 - new\_password1
- new\_password2 - new\_password2
4. /rest\_accounts/login/ - POST 4. /rest\_accounts/login/
- POST
- username - username
- password - password
5. /rest\_accounts/verify-email/{activation\_key}/ - GET 5. /rest\_accounts/verify-email/{activation\_key}/
- GET
API endpoints with Authentication API endpoints with Authentication
--------------------------------- ---------------------------------
1. /rest\_accounts/logout/ - GET 1. /rest\_accounts/logout/
- GET
2. /rest\_accounts/user/ - GET & POST 2. /rest\_accounts/user/
- GET & POST
- POST parameters - POST parameters
- user as dictionary - user as dictionary
- user-defined UserProfile model fields - user-defined UserProfile model fields
- user data example - user data example
"user": {"id": 1, "first_name": "Person", "last_name": "2"} "user": {"id": 1, "first_name": "Person", "last_name": "2"}
3. /rest\_accounts/password/change/ - POST 3. /rest\_accounts/password/change/
- POST
- new\_password1 - new\_password1
- new\_password2 - new\_password2