Wie kann ich CORS im Django REST Framework aktivieren?

Wie kann ich CORS auf meinem Django REST Framework aktivieren? Die Referenz hilft nicht viel, es heißt, dass ich es mit einer Middleware machen kann, aber wie kann ich das machen?

Der Link, auf den Sie in Ihrer Frage verwiesen haben, empfiehlt die Verwendung django-cors-headerswessen Dokumentation sagt, die Bibliothek zu installieren

python -m pip install django-cors-headers

und fügen Sie es dann zu Ihren installierten Apps hinzu:

INSTALLED_APPS = (
    ...
    'corsheaders',
    ...
)

Sie müssen außerdem eine Middleware-Klasse hinzufügen, um Antworten abzuhören:

MIDDLEWARE = [
    ...,
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
    ...,
]

und geben Sie Domänen für CORS an, z. B.:

CORS_ALLOWED_ORIGINS = [
    'http://localhost:3030',
]

Bitte stöbern Sie den Konfigurationsabschnitt seiner Dokumentation unter besonderer Berücksichtigung der verschiedenen CORS_ORIGIN_ Einstellungen. Einige davon müssen Sie entsprechend Ihren Anforderungen festlegen.

python -m pip install django-cors-headers

und fügen Sie es dann zu Ihren installierten Apps hinzu:

INSTALLED_APPS = [
    ...
    'corsheaders',
    ...
]

Sie müssen außerdem eine Middleware-Klasse hinzufügen, um Antworten abzuhören:

MIDDLEWARE = [
    ...,
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
    ...,
]

CORS_ALLOW_ALL_ORIGINS = True # If this is used then `CORS_ALLOWED_ORIGINS` will not have any effect
CORS_ALLOW_CREDENTIALS = True
CORS_ALLOWED_ORIGINS = [
    'http://localhost:3030',
] # If this is used, then not need to use `CORS_ALLOW_ALL_ORIGINS = True`
CORS_ALLOWED_ORIGIN_REGEXES = [
    'http://localhost:3030',
]

mehr Details: https://github.com/ottoyiu/django-cors-headers/#configuration

Das Lesen der offiziellen Dokumentation kann fast alle Probleme lösen

Sie können dies tun, indem Sie eine benutzerdefinierte Middleware verwenden, obwohl Sie wissen, dass die beste Option darin besteht, den getesteten Ansatz des Pakets zu verwenden django-cors-headers. Vor diesem Hintergrund ist hier die Lösung:

Erstellen Sie die folgende Struktur und Dateien:

— myapp/middleware/__init__.py

from corsMiddleware import corsMiddleware

— myapp/middleware/corsMiddleware.py

class corsMiddleware(object):
    def process_response(self, req, resp):
        resp["Access-Control-Allow-Origin"] = "*"
        return resp

ergänzen settings.py die markierte Zeile:

MIDDLEWARE_CLASSES = (
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",

    # Now we add here our custom middleware
     'app_name.middleware.corsMiddleware' <---- this line
)

Falls jemand auf diese Frage zurückkommt und beschließt, seine eigene Middleware zu schreiben, ist dies ein Codebeispiel für Djangos Middleware im neuen Stil –

class CORSMiddleware(object):
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        response = self.get_response(request)
        response["Access-Control-Allow-Origin"] = "*"

        return response

Für Django-Versionen > 1.10 laut Dokumentationeine benutzerdefinierte MIDDLEWARE kann als Funktion geschrieben werden, sagen wir in der Datei: yourproject/middleware.py (als Geschwister von settings.py):

def open_access_middleware(get_response):
    def middleware(request):
        response = get_response(request)
        response["Access-Control-Allow-Origin"] = "*"
        response["Access-Control-Allow-Headers"] = "*"
        return response
    return middleware

und schließlich fügen Sie den Python-Pfad dieser Funktion (bezogen auf das Stammverzeichnis Ihres Projekts) zur MIDDLEWARE-Liste in Ihrem Projekt hinzu settings.py:

MIDDLEWARE = [
  .
  .
  'django.middleware.clickjacking.XFrameOptionsMiddleware',
  'yourproject.middleware.open_access_middleware'
]

Kinderleicht!

Nachfolgend finden Sie die Arbeitsschritte ohne die Notwendigkeit externer Module:

Schritt 1: Erstellen Sie ein Modul in Ihrer App.

Nehmen wir zum Beispiel an, wir haben eine App namens user_registration_app. Erkunden Sie user_registration_app und erstellen Sie eine neue Datei.

Nennen wir es als custom_cors_middleware.py

Fügen Sie die folgende Klassendefinition ein:

class CustomCorsMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response
        # One-time configuration and initialization.

    def __call__(self, request):
        # Code to be executed for each request before
        # the view (and later middleware) are called.

        response = self.get_response(request)
        response["Access-Control-Allow-Origin"] = "*"
        response["Access-Control-Allow-Headers"] = "*"

        # Code to be executed for each request/response after
        # the view is called.

        return response

Schritt 2: Registrieren Sie eine Middleware

Fügen Sie in Ihrer Projektdatei „settings.py“ diese Zeile hinzu

‘user_registration_app.custom_cors_middleware.CustomCorsMiddleware’

Z.B:

  MIDDLEWARE = [
        'user_registration_app.custom_cors_middleware.CustomCorsMiddleware', # ADD THIS LINE BEFORE CommonMiddleware
         ...
        'django.middleware.common.CommonMiddleware',

    ]

Denken Sie daran, es auszutauschen user_registration_app durch den Namen Ihrer App, in der Sie Ihr Modul „custom_cors_middleware.py“ erstellt haben.

Sie können jetzt überprüfen, ob allen Ansichten im Projekt die erforderlichen Antwortheader hinzugefügt werden!

Aktualisiert 2021 Für alle, die die neueste Version von Django v3.xx haben: Die Schritte zum Zulassen von CORS von jedem Ursprung sind unten aufgeführt.

Schritt 1: Erforderliche Bibliothek installieren

pip install django-cors-headers

Schritt 2: Fügen Sie es dann an der richtigen Stelle in Ihrem hinzu INSTALLED_APPS In settings.py – nach dem rest_framework und vor Ihrer Bewerbung myapp

'rest_framework',
'corsheaders',
'myapp.apps.MyAppConfig',

Schritt 3: Erlauben Sie die Ursprünge für Ihre API (innen). settings.py)

CORS_ORIGIN_WHITELIST = (
'http://localhost:3000',  # for localhost (REACT Default)
'http://192.168.10.45:3000', # for network
)