Set Up API, add Views for Sports and Criterions

Co-authored-by: Dominik <dominip89@mi.fu-berlin.de>
Co-authored-by: Josie <josiepark@mi.fu-berlin.de>

unisportomat/quiz/admin.py

@@ -3,6 +3,8 @@
 from django.contrib import admin
 
 # Register your models here.
-from .models import Sport
+from .models import Sport, Criterion, CriterionRating
 
 admin.site.register(Sport)
+admin.site.register(Criterion)
+admin.site.register(CriterionRating)

unisportomat/quiz/apps.py

@@ -4,6 +4,7 @@ from django.apps import AppConfig
 
 
 class QuizConfig(AppConfig):
-    """Application Config for the quiz app """
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'quiz'
+    """Application Config for the quiz app"""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "quiz"

unisportomat/quiz/models.py

@@ -54,3 +54,4 @@ class Criterion(models.Model):
     """
 
     name = models.TextField()
+    sport_ratings = models.ManyToManyField("Sport", through="CriterionRating")

unisportomat/quiz/serializers.py

+"""
+Serializers creating JSONs for every Model from .models
+"""
+from rest_framework import serializers
+from .models import Sport, Criterion
+
+
+class SportListSerializer(serializers.ModelSerializer):
+    """
+    Serializes all sports.
+    """
+
+    class Meta:
+        model = Sport
+        fields = ("id", "name", "url", "criteria_ratings")
+
+
+class CriterionListSerializer(serializers.ModelSerializer):
+    """
+    Serializes Criterions
+    """
+
+    class Meta:
+        model = Criterion
+        fields = ("id", "name", "sport_ratings")

unisportomat/quiz/views.py

-""" Defines the views for the quiz app """
+"""
+Defines the views for the API
+"""
+
+from django.shortcuts import render
+from rest_framework import viewsets
+from .serializers import SportListSerializer, CriterionListSerializer
+from .models import Sport, Criterion
 
 # Create your views here.
+
+
+class SportListView(viewsets.ModelViewSet):
+    """
+    A View returning every Sport Object
+    """
+
+    serializer_class = SportListSerializer
+    queryset = Sport.objects.all()
+
+
+class CriterionListView(viewsets.ModelViewSet):
+    """
+    A View returning every Criterion Object
+    """
+
+    serializer_class = CriterionListSerializer
+    queryset = Criterion.objects.all()

unisportomat/unisportomat/settings.py

@@ -20,7 +20,7 @@ BASE_DIR = Path(__file__).resolve().parent.parent
 # See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'django-insecure-vl*o#be$=k)9mbtm3!8k!6pe&38cdfg1*#_y3s)kgp$czt4ctm'
+SECRET_KEY = "django-insecure-vl*o#be$=k)9mbtm3!8k!6pe&38cdfg1*#_y3s)kgp$czt4ctm"
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -31,53 +31,57 @@ ALLOWED_HOSTS = []
 # Application definition
 
 INSTALLED_APPS = [
-    'quiz.apps.QuizConfig',
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
+    # "quiz.apps.QuizConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "rest_framework",
+    "corsheaders",
+    "quiz",
 ]
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "corsheaders.middleware.CorsMiddleware",
 ]
 
-ROOT_URLCONF = 'unisportomat.urls'
+ROOT_URLCONF = "unisportomat.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
             ],
         },
     },
 ]
 
-WSGI_APPLICATION = 'unisportomat.wsgi.application'
+WSGI_APPLICATION = "unisportomat.wsgi.application"
 
 
 # Database
 # https://docs.djangoproject.com/en/3.2/ref/settings/#databases
 
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
     }
 }
 
@@ -87,16 +91,16 @@ DATABASES = {
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
     },
 ]
 
@@ -104,9 +108,9 @@ AUTH_PASSWORD_VALIDATORS = [
 # Internationalization
 # https://docs.djangoproject.com/en/3.2/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
@@ -118,9 +122,14 @@ USE_TZ = True
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/3.2/howto/static-files/
 
-STATIC_URL = '/static/'
+STATIC_URL = "/static/"
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
 
-DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+CORS_ORITIN_WHITELIST = [
+    "http://localhost:3000",  # User Frontend
+    "http://localhost:4000",  # Admin Frontend
+]

unisportomat/unisportomat/urls.py

@@ -14,8 +14,15 @@ Including another URLconf
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.contrib import admin
-from django.urls import path
+from django.urls import path, include
+from rest_framework import routers
+from quiz import views
+
+router = routers.DefaultRouter()
+router.register(r"sport-list", views.SportListView, "sport-list")
+router.register(r"criterion-list", views.CriterionListView, "criterion-list")
 
 urlpatterns = [
-    path('admin/', admin.site.urls),
+    path("admin/", admin.site.urls),
+    path("api/admin/", include(router.urls)),
 ]