Fixing urls; adding home and api root

Author: camilamaia

demo/api/models.py

@@ -0,0 +1,16 @@
+from django.urls import path
+
+from demo.api import views
+
+urlpatterns = [
+    path("", views.root, name="api-root"),
+    path("health/", views.health, name="api-health"),
+    path("devs/", views.dev_list, name="api-dev-list"),
+    path("devs/<uuid:identifier>", views.dev_details, name="api-dev-details"),
+    path(
+        "devs/<uuid:identifier>/languages",
+        views.dev_details_languages,
+        name="api-dev-details-languages",
+    ),
+    path("languages/", views.language_list, name="api-language-list"),
+]

demo/api/urls.py

@@ -31,6 +31,18 @@
 DEVS = [ANNA, LOUIS, MARCUS]
 
 
+def root(request):
+    return HttpResponse(
+        "<a href=https://demo.scanapi.dev/api/health>https://demo.scanapi.dev/api/health</a><br>"
+        "<a href=https://demo.scanapi.dev/api/devs>https://demo.scanapi.dev/api/devs</a><br>"
+        "<a href=https://demo.scanapi.dev/api/devs?newOpportunities=true>https://demo.scanapi.dev/api/devs?newOpportunities=true</a><br>"
+        "<a href=https://demo.scanapi.dev/api/devs?newOpportunities=false>https://demo.scanapi.dev/api/devs?newOpportunities=false</a><br>"
+        "<a href=https://demo.scanapi.dev/api/languages>https://demo.scanapi.dev/api/languages</a><br>"
+        "<a href=https://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0>https://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0</a><br>"
+        "<a href=https://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0/languages>https://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0/languages</a><br>"
+    )
+
+
 def health(request):
     if request.method == "GET":
         return HttpResponse("OK!")
@@ -40,16 +52,16 @@ def health(request):
 
 @csrf_exempt
 def dev_list(request):
-    if is_not_authenticated(request):
-        return not_authenticated()
-
     if request.method == "GET":
         newOpportunities = request.GET.get("newOpportunities")
         devs = filter_devs_by_new_opportunities(newOpportunities)
 
         return JsonResponse(devs, safe=False)
 
     if request.method == "POST":
+        if is_not_authenticated(request):
+            return not_authenticated()
+
         body = json.loads(str(request.body, encoding="utf-8"))
         return JsonResponse(body, status=201, safe=False)
 
@@ -58,9 +70,6 @@ def dev_list(request):
 
 @csrf_exempt
 def dev_details(request, identifier):
-    if is_not_authenticated(request):
-        return not_authenticated()
-
     uuid = str(identifier)
     dev = get_dev(uuid)
     if request.method == "GET":
@@ -70,6 +79,9 @@ def dev_details(request, identifier):
         return JsonResponse(dev, status=200, safe=False)
 
     if request.method == "DELETE":
+        if is_not_authenticated(request):
+            return not_authenticated()
+
         if not dev:
             return dev_not_found(uuid)
 
@@ -79,9 +91,6 @@ def dev_details(request, identifier):
 
 
 def dev_details_languages(request, identifier):
-    if is_not_authenticated(request):
-        return not_authenticated()
-
     uuid = str(identifier)
     dev = get_dev(uuid)
     if request.method == "GET":
@@ -94,9 +103,6 @@ def dev_details_languages(request, identifier):
 
 
 def language_list(request):
-    if is_not_authenticated(request):
-        return not_authenticated()
-
     return JsonResponse(["c", "go", "java", "python", "ruby"], safe=False)
 
 

demo/api/views.py

@@ -115,5 +115,7 @@
 
 STATIC_URL = "/static/"
 
+APPEND_SLASH = True
+
 # Activate Django-Heroku.
 django_heroku.settings(locals())

demo/settings.py

@@ -1,31 +1,12 @@
-"""demo URL Configuration
+from django.http import HttpResponse
+from django.urls import path, include
 
-The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/3.0/topics/http/urls/
-Examples:
-Function views
-    1. Add an import:  from my_app import views
-    2. Add a URL to urlpatterns:  path('', views.home, name='home')
-Class-based views
-    1. Add an import:  from other_app.views import Home
-    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
-Including another URLconf
-    1. Import the include() function: from django.urls import include, path
-    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
-"""
-from django.contrib import admin
-from django.urls import path
 
-from demo.api import views
+def home(request):
+    return HttpResponse(
+        "Welcome to ScanAPI Demo."
+        "\n\nAccess the demo api at: https://demo.scanapi.dev/api"
+    )
 
-urlpatterns = [
-    path("api/health", views.health, name="api-health"),
-    path("api/devs/", views.dev_list, name="api-dev-list"),
-    path("api/devs/<uuid:identifier>", views.dev_details, name="api-dev-details"),
-    path(
-        "api/devs/<uuid:identifier>/languages",
-        views.dev_details_languages,
-        name="api-dev-details-languages",
-    ),
-    path("api/languages/", views.language_list, name="api-language-list"),
-]
+
+urlpatterns = [path("", home, name="index"), path("api/", include("demo.api.urls"))]