Added RestAPI to return information about signals

Author: dmytrotsko

src/rest_api/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

src/rest_api/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class RestApiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'rest_api'

src/rest_api/apps.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

src/rest_api/migrations/__init__.py

@@ -0,0 +1,22 @@
+from rest_framework.serializers import ModelSerializer, SlugRelatedField
+
+from signals.models import Signal
+
+
+class SignalSerializer(ModelSerializer):
+    """
+    Serializer for the Signal model.
+    """
+
+    source = SlugRelatedField(read_only=True, slug_field="name")
+    signal_type = SlugRelatedField(read_only=True, slug_field="name")
+    available_geography = SlugRelatedField(many=True, read_only=True, slug_field="name")
+
+    class Meta:
+        model = Signal
+        fields = [
+            "name",
+            "source",
+            "signal_type",
+            "available_geography",
+        ]

src/rest_api/models.py

@@ -0,0 +1,9 @@
+from django.urls import path
+from django.urls.resolvers import URLPattern
+
+from rest_api.views import api_signal_detail_view
+
+
+urlpatterns: list[URLPattern] = [
+    path("signal/<int:pk>", api_signal_detail_view, name="api_signal_detail"),
+]

src/rest_api/serializers.py

@@ -0,0 +1,32 @@
+from rest_framework.decorators import api_view
+from rest_framework.response import Response
+
+from rest_api.serializers import SignalSerializer
+from signals.models import Signal
+
+
+@api_view(
+    [
+        "GET",
+    ]
+)
+def api_signal_detail_view(request, pk):
+    """
+    API view for getting a single Signal object.
+
+    Args:
+        request: The request object.
+        pk: The primary key of the Signal object.
+
+    Returns:
+        Response: The response object.
+    """
+
+    try:
+        signal = Signal.objects.get(pk=pk)
+    except Signal.DoesNotExist:
+        return Response(status=404)
+
+    if request.method == "GET":
+        serializer = SignalSerializer(signal)
+        return Response(serializer.data)

src/rest_api/urls.py

@@ -105,6 +105,7 @@
     'datasources',
     'signals',
     'signal_sets',
+    'rest_api',
 ]
 
 INSTALLED_APPS: list[str] = DEFAULT_APPS + EXTERNAL_APPS + LOCAL_APPS

src/rest_api/views.py

@@ -47,9 +47,14 @@
     ),
     # datasources
     path(
-        f"{settings.MAIN_PAGE}/datasources/" if settings.MAIN_PAGE else "datasources",
+        f"{settings.MAIN_PAGE}/datasources/" if settings.MAIN_PAGE else "datasources/",
         include("datasources.urls"),
     ),
+    # rest_api
+    path(
+        f"{settings.MAIN_PAGE}/rest_api/" if settings.MAIN_PAGE else "rest_api/",
+        include("rest_api.urls"),
+    ),
     path("__debug__/", include("debug_toolbar.urls")),
 ]