如何使用迁移框架添加Django REST Framework身份验证令牌

时间:2015-09-22 17:52:06

标签: django django-rest-framework django-migrations http-token-authentication

我正在使用Django REST Framework设置一个新的API,我需要向所有现有用户添加Auth令牌。文档说:

from django.contrib.auth.models import User
from rest_framework.authtoken.models import Token

for user in User.objects.all():
    Token.objects.get_or_create(user=user)

但理想情况下,这应该是使用Django的新移植框架。

有一种简单的方法吗?

2 个答案:

答案 0 :(得分:2)

首先为您希望与之一起使用的应用创建一个空迁移。就我而言,我有一个名为users的应用程序,这种东西存在,所以我跑了:

manage.py makemigrations users --empty

在我的迁移目录中创建了一个新文件,我可以使用以下内容进行更新:

# -*- coding: utf-8 -*-
from __future__ import unicode_literals

from django.db import models, migrations
from rest_framework.authtoken.models import Token
from django.contrib.auth.models import User

def add_tokens(apps, schema_editor):
    print "Adding auth tokens for the API..."
    for user in User.objects.all():
        Token.objects.get_or_create(user=user)

def remove_tokens(apps, schema_editor):
    print "Deleting all auth tokens for the API..."
    Token.objects.all().delete()

class Migration(migrations.Migration):

    dependencies = [
        ('users', '0002_load_initial_data'),
    ]

    operations = [
        migrations.RunPython(add_tokens, reverse_code=remove_tokens),
    ]

答案 1 :(得分:2)

这里的窍门是知道Token使用自定义save()方法来生成唯一的token.key,但是自定义save()方法不在迁移内部运行。因此,第一个令牌将具有一个空白密钥,而第二个令牌将失败并带有一个IntegrityError,因为它们的密钥也是空白且不是唯一的。

相反,将generate_key()代码复制到您的迁移文件中,如下所示:

# Generated with `manage.py makemigrations --empty YOUR-APP`.

import binascii
import os

from django.db import migrations

# Copied from rest_framework/authtoken/models.py.
def generate_key():
    return binascii.hexlify(os.urandom(20)).decode()

def create_tokens(apps, schema_editor):
    User = apps.get_model('auth', 'User')
    Token = apps.get_model('authtoken', 'Token')
    for user in User.objects.filter(auth_token__isnull=True):
        token, _ = Token.objects.get_or_create(user=user, key=generate_key())

class Migration(migrations.Migration):

    dependencies = [
        ('YOUR-APP', 'YOUR-PREVIOUS-MIGRATION'),
    ]

    operations = [
        migrations.RunPython(create_tokens),
    ]

您应避免将rest_framework代码直接导入迁移中,否则有一天迁移将无法运行,因为您决定删除rest_framework或更改了库的界面。迁移需要及时冻结。