**Django Rest Social Auth安装与配置指南**

Django Rest Social Auth安装与配置指南

django-rest-social-authOAuth signin with django rest framework项目地址:https://gitcode.com/gh_mirrors/dj/django-rest-social-auth

---

1. 项目目录结构及介绍

django-rest-social-auth 是一个旨在简化Django REST Framework中社交账号认证流程的库。以下是该库的一个基本目录结构示例以及关键文件的简要说明：

django-rest-social-auth/
├── LICENSE.txt                # 许可证文件
├── README.md                  # 项目简介和快速入门指南
├── requirements.txt           # 必需的依赖包列表
├── setup.py                   # Python包的设置文件，用于安装
├── src/
│   └── rest_social_auth       # 主要源代码所在目录
│       ├── __init__.py        # 包初始化文件
│       ├── apps.py            # Django应用配置
│       ├── serializers.py     # 序列化器，处理社交认证的数据转换
│       ├── urls.py            # API的URL配置
│       └── views.py           # 视图，实现社交登录的核心逻辑
└── tests/                     # 测试目录，包含各种测试案例

• src/rest_social_auth: 核心功能模块，包含了与社交认证相关的视图、序列化器和其他逻辑。
• tests: 包含单元测试和集成测试以确保项目功能的健壮性。

---

2. 项目启动文件介绍

在实际开发中，项目启动涉及到的不是django-rest-social-auth本身的启动文件，而是你的Django项目的manage.py。不过，关注点在于如何将此库融入到你的项目中。通常，你需要修改以下几个部分来启用社交认证：

• 添加到 INSTALLED_APPS: 在你的settings.py里，增加 'rest_social_auth', 'social_django', 及其他必要的如'rest_framework.authtoken'等。

• 配置社交认证: 在同一settings.py中，定义SOCIAL_AUTH_{PROVIDER}_KEY 和 SOCIAL_AUTH_{PROVIDER}_SECRET （替换{PROVIDER}为如Facebook、Google等具体提供商），并调整AUTHENTICATION_BACKENDS以包括python-social-auth的相关后端。

• URL配置: 在你的主urls.py中包含rest_social_auth的URL模式，通常通过导入其urls模块并包含它们。

---

3. 项目的配置文件介绍

settings.py 配置要点:

• 添加依赖: 首先，确保通过pip安装了所有必需的依赖（如文首引用指令所示）。

• INSTALLED_APPS 更新:

  INSTALLED_APPS = [
      ...,
      'rest_framework',
      'rest_framework.authtoken',  # 如果使用Token认证
      'social_django',             # 社交认证所需
      'rest_social_auth',          # 本项目
      ...
  ]
  

• 社交认证设置 (SOCIAL_AUTH_*):

  • 设置您的社交应用的API密钥和秘钥，例如对于Facebook：

    SOCIAL_AUTH_FACEBOOK_KEY = 'YOUR_APP_ID'
    SOCIAL_AUTH_FACEBOOK_SECRET = 'YOUR_APP_SECRET'
    

• 认证后端: 确保在 AUTHENTICATION_BACKENDS 中包含了社交认证的后台:

  AUTHENTICATION_BACKENDS = (
      'social_core.backends.facebook.FacebookOAuth2',
      # 可能还有其他的认证后端
      'django.contrib.auth.backends.ModelBackend',
  )
  

• 额外设置 (可选): 如指定社交账户获取额外数据或语言设置。

完成这些配置后，你的Django REST应用就能开始支持社交登录了。记得详细阅读官方文档和示例项目，以便更深入地定制和理解每一部分的具体作用。

django-rest-social-authOAuth signin with django rest framework项目地址:https://gitcode.com/gh_mirrors/dj/django-rest-social-auth