feat: Реализовано базовое простое API

Минимальное, но самодостаточное

backend/backend/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 
-from .models import ToDoList
+from .models import ToDoList, ToDoItem
 
 
 class ToDoListAdmin(admin.ModelAdmin):
@@ -9,4 +9,11 @@ class ToDoListAdmin(admin.ModelAdmin):
     list_editable = ["title"]
 
 
+class ToDoItemAdmin(admin.ModelAdmin):
+    model = ToDoItem
+    list_display = ["parent", "finished", "text", "created_at"]
+    list_editable = ["finished", "text"]
+
+
 admin.site.register(ToDoList, ToDoListAdmin)
+admin.site.register(ToDoItem, ToDoItemAdmin)

backend/backend/api.py

@@ -1,20 +1,50 @@
 from rest_framework import viewsets, serializers, permissions
 from rest_framework import routers
+from django_filters.rest_framework import DjangoFilterBackend
 
-from .models import ToDoList
+from .models import ToDoList, ToDoItem
+
+
+class ToDoItemSerializer(serializers.HyperlinkedModelSerializer):
+    parent = serializers.PrimaryKeyRelatedField(many=False, read_only=True)
+
+    class Meta:
+        model = ToDoItem
+        fields = ["id", "text", "finished", "created_at", "parent"]
+
+
+class ToDoItemViewSet(viewsets.ModelViewSet):
+    serializer_class = ToDoItemSerializer
+    permission_classes = [permissions.IsAuthenticated]
+    filter_backends = [DjangoFilterBackend]
+    filterset_fields = ["parent", "finished"]
+
+    def get_queryset(self):
+        user = self.request.user
+        if not user.is_authenticated:
+            # ветка только для генерации схемы
+            return ToDoItem.objects.all()
+        return ToDoItem.objects.filter(parent__user=user)
 
 
 class ToDoListSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = ToDoList
-        fields = ["title", "created_at"]
+        fields = ["id", "title", "created_at"]
 
 
 class ToDoListViewSet(viewsets.ModelViewSet):
-    queryset = ToDoList.objects.all()
     serializer_class = ToDoListSerializer
     permission_classes = [permissions.IsAuthenticated]
 
+    def get_queryset(self):
+        user = self.request.user
+        if not user.is_authenticated:
+            # ветка только для генерации схемы
+            return ToDoList.objects.all()
+        return ToDoList.objects.filter(user=user)
+
 
 router = routers.DefaultRouter()
-router.register(r"lists", ToDoListViewSet)
+router.register(r"lists", ToDoListViewSet, basename="ToDoLists")
+router.register(r"todo_items", ToDoItemViewSet, basename="ToDoItems")

backend/backend/migrations/0002_todoitem_finished.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2 on 2021-04-17 11:15
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("backend", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="todoitem",
+            name="finished",
+            field=models.BooleanField(default=False),
+        ),
+    ]

backend/backend/migrations/0003_auto_20210417_1157.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2 on 2021-04-17 11:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("backend", "0002_todoitem_finished"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="todoitem",
+            name="created_at",
+            field=models.DateTimeField(auto_now_add=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name="todoitem",
+            name="finished",
+            field=models.BooleanField(db_index=True, default=False),
+        ),
+        migrations.AlterField(
+            model_name="todolist",
+            name="created_at",
+            field=models.DateTimeField(auto_now_add=True, db_index=True),
+        ),
+    ]

backend/backend/models.py

@@ -5,10 +5,11 @@ from django.contrib.auth.models import User
 class ToDoList(models.Model):
     user = models.ForeignKey(User, on_delete=models.CASCADE, null=False, default=None)
     title = models.CharField(max_length=250)
-    created_at = models.DateTimeField(auto_now_add=True)
+    created_at = models.DateTimeField(auto_now_add=True, db_index=True)
 
 
 class ToDoItem(models.Model):
     parent = models.ForeignKey(ToDoList, on_delete=models.CASCADE, null=False, default=None)
     text = models.TextField()
-    created_at = models.DateTimeField(auto_now_add=True)
+    finished = models.BooleanField(default=False, null=False, db_index=True)
+    created_at = models.DateTimeField(auto_now_add=True, db_index=True)

backend/backend/settings.py

@@ -27,7 +27,8 @@ SECRET_KEY = "django-insecure-toz+*lt(ejm!l*)92w2ciqoh^1kz#a(abbpcn54-dbw(nxoy&7
 DEBUG = True
 
 ALLOWED_HOSTS = []
-
+if DEBUG:
+    ALLOWED_HOSTS = ["0.0.0.0", "localhost", "127.0.0.1"]
 
 # Application definition
 
@@ -40,8 +41,13 @@ INSTALLED_APPS = [
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "rest_framework",
+    "drf_yasg",
 ]
 
+SWAGGER_SETTINGS = {
+    "SECURITY_DEFINITIONS": {"Bearer": {"type": "apiKey", "name": "Authorization", "in": "header"}}
+}
+
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
@@ -118,7 +124,12 @@ SIMPLE_JWT = {
 }
 
 REST_FRAMEWORK = {
-    "DEFAULT_AUTHENTICATION_CLASSES": ("rest_framework_simplejwt.authentication.JWTAuthentication",)
+    "DEFAULT_AUTHENTICATION_CLASSES": (
+        "rest_framework_simplejwt.authentication.JWTAuthentication",
+    ),
+    "DEFAULT_FILTER_BACKENDS": ["django_filters.rest_framework.DjangoFilterBackend"],
+    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
+    "PAGE_SIZE": 100,
 }
 
 

backend/backend/urls.py

@@ -6,8 +6,21 @@ from rest_framework_simplejwt.views import (
     TokenRefreshView,
 )
 
+from rest_framework import permissions
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
+
 from .api import router
 
+schema_view = get_schema_view(
+   openapi.Info(
+      title="ToDo List",
+      default_version='v1',
+      description="Swagger Interface for ToDo List",
+   ),
+   public=True,
+   permission_classes=(permissions.AllowAny,),
+)
 
 urlpatterns = [
     path("admin/", admin.site.urls),
@@ -15,4 +28,5 @@ urlpatterns = [
     path("api/token/refresh/", TokenRefreshView.as_view(), name="token_refresh"),
     path("api/", include(router.urls)),
     path("api-auth/", include("rest_framework.urls", namespace="rest_framework")),
+    path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
 ]

backend/requirements.txt

@@ -1,4 +1,5 @@
 djangorestframework==3.12.4
+django-filter==2.4.0
 markdown==3.3.4
 appdirs==1.4.4
 asgiref==3.3.4
@@ -21,3 +22,4 @@ toml==0.10.2
 urllib3==1.26.4
 djangorestframework-simplejwt==4.6.0
 psycopg2-binary>=2.8
+drf-yasg==1.20.0