Getting started

Available endpoints

  • /users/
  • /users/me/
  • /users/confirm/
  • /users/change_username/
  • /password/
  • /password/reset/
  • /password/reset/confirm/
  • /token/login/ (基于令牌的身份验证)
  • /token/logout/ (基于令牌的身份验证)
  • /jwt/create/ (JSON Web令牌认证)
  • /jwt/refresh/ (JSON Web令牌认证)
  • /jwt/verify/ (JSON Web令牌认证)

Supported authentication backends

Supported Python versions

  • Python 2.7
  • Python 3.4
  • Python 3.5
  • Python 3.6

Supported Django versions

  • Django 1.11
  • Django 2.0

Supported Django Rest Framework versions

  • Django Rest Framework 3.7

Installation

$ pip install -U djoser

如果要使用JWT身份验证,则还需要使用以下命令安装djangorestframework_simplejwt

$ pip install -U djangorestframework_simplejwt

最后,如果您要使用基于第三方的身份验证,例如facebook,则需要使用以下命令安装social-auth-app-django

$ pip install -U social-auth-app-django

Configuration

Configure INSTALLED_APPS:

INSTALLED_APPS = (
    'django.contrib.auth',
    (...),
    'rest_framework',
    'djoser',
    (...),
)

Configure urls.py:

urlpatterns = [
    (...),
    url(r'^auth/', include('djoser.urls')),
]

Django Rest Framework会默认采用HTTP Basic Auth策略. 我们强烈建议不要对基本身份验证提供任何明确的支持. 您应该按照身份验证后端中的说明自定义身份验证后端 .

在基于第三方的身份验证的情况下, PSA后端文档将是配置给定提供程序的很好的参考.