Django REST Auth 使用指南

最新推荐文章于 2024-09-10 09:53:11 发布

邵娇湘

最新推荐文章于 2024-09-10 09:53:11 发布

阅读量660

点赞数 13

本文链接：https://blog.csdn.net/gitblog_00260/article/details/141486707

版权

Django REST Auth 使用指南

django-rest-authThis app makes it extremely easy to build Django powered SPA's (Single Page App) or Mobile apps exposing all registration and authentication related functionality as CBV's (Class Base View) and REST (JSON)项目地址:https://gitcode.com/gh_mirrors/dj/django-rest-auth

项目简介

Django REST Auth 是一个基于 Django 和 Django REST Framework 的扩展，它提供了用户认证（Authentication）和注册（Registration）的功能，以及与Django Allauth的集成，方便开发RESTful API中的用户管理。

1. 项目目录结构及介绍

以下是对 django-rest-auth 主要目录结构的解析：

django-rest-auth/
|-- rest_auth/                  # 核心模块，实现认证与登录逻辑
    |-- views.py               # 包含视图函数，如登录、注销等
    |-- serializers.py         # 序列化器定义，用于数据验证和转换
    |-- urls.py                # API的URL配置
|-- rest_auth.registration/     # 用户注册相关功能模块
    |-- views.py               # 注册视图函数
    |-- serializers.py         # 注册过程的数据序列化
    |-- urls.py                # 注册API的URL配置
|-- tests/                      # 单元测试代码
|-- project_name/              # 示例项目可能会包含的目录，具体项目自定义
|-- requirements.txt           # 项目依赖列表
|-- setup.py                   # 用于打包发布的Python脚本
|-- README.rst                 # 项目说明文档

2. 项目的启动文件介绍

在 Django 中，通常没有单一的“启动文件”，但有关键的几个步骤来启动包含 django-rest-auth 的项目：

settings.py 修改：首先，在你的项目的 settings.py 文件中，你需要添加 rest_auth 到 INSTALLED_APPS。

INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework.authtoken', 
    'django.contrib.sites',       # 如果你使用Allauth集成
    'allauth',                    # 同上，需要安装
    'allauth.account',            # 同上，提供额外功能
    'rest_auth',                  # 添加此行
    'rest_auth.registration',    # 若开启用户注册功能，也需添加
    ...
]

并且配置站点ID，安装所需的中间件，以及可能的认证类和URL设置。

urls.py 配置：然后，在项目的或app的 urls.py 中引入并配置 rest_auth 的URL模式。

from django.urls import path, include

urlpatterns = [
    ...
    path('api/auth/', include('rest_auth.urls')),
    path('api/auth/register/', include('rest_auth.registration.urls')),
    ...
]

3. 项目的配置文件介绍

settings.py 中的相关配置

在 settings.py 文件，你需要进行一系列的配置以适应你的应用需求。关键配置包括：

数据库连接
SECRET_KEY - 项目安全密钥。
SITE_ID - 当使用Django Allauth时，需要指定站点ID。

REST_FRAMEWORK - 配置REST框架的行为，例如认证策略。

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.TokenAuthentication',  # 常用认证方式之一
    ),
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated',        # 控制访问权限
    )
}