add new api inside the current view set

Author: Ahtesham Quraish

articles/models.py

@@ -27,15 +27,21 @@ class Article(TimestampedModel):
     def save(self, *args, **kwargs):
         previous = Article.objects.get(pk=self.pk) if self.pk else None
         was_published = getattr(previous, "is_published", None)
-        if not was_published:
+
+        # Always initialize slug
+        slug = self.slug or None
+
+        if not was_published and self.is_published:
             max_length = self._meta.get_field("slug").max_length
+
             base_slug = slugify(self.title)[:max_length]
             slug = base_slug
             counter = 1
 
+            # Prevent collisions
             while Article.objects.filter(slug=slug).exclude(pk=self.pk).exists():
                 suffix = f"-{counter}"
-                slug = f"{base_slug[: 60 - len(suffix)]}{suffix}"
+                slug = f"{base_slug[: max_length - len(suffix)]}{suffix}"
                 counter += 1
 
         self.slug = slug

articles/urls.py

@@ -2,7 +2,7 @@
 from rest_framework.routers import SimpleRouter
 
 from articles import views
-from .views import MediaUploadView, ArticleDetailByIdOrSlugAPIView
+from .views import MediaUploadView
 
 v1_router = SimpleRouter()
 v1_router.register(
@@ -12,26 +12,21 @@
 )
 
 app_name = "articles"
+
 urlpatterns = [
     re_path(
         r"^api/v1/",
         include(
             (
                 [
-                    # Existing router URLs for the ViewSet
+                    # All ViewSet routes
                     *v1_router.urls,
                     # Media upload endpoint
                     path(
                         "upload-media/",
                         MediaUploadView.as_view(),
                         name="api-media-upload",
                     ),
-                    # New endpoint: retrieve article by ID or slug
-                    path(
-                        "articles/detail/<str:identifier>/",
-                        ArticleDetailByIdOrSlugAPIView.as_view(),
-                        name="article-detail-by-id-or-slug",
-                    ),
                 ],
                 "v1",
             )

articles/views.py

@@ -12,6 +12,8 @@
 from rest_framework.response import Response
 from rest_framework.views import APIView
 from django.shortcuts import get_object_or_404
+from rest_framework.decorators import action
+from drf_spectacular.utils import extend_schema, OpenApiParameter, OpenApiResponse
 
 
 from articles.models import Article
@@ -80,45 +82,35 @@ def destroy(self, request, *args, **kwargs):
         clear_views_cache()
         return super().destroy(request, *args, **kwargs)
 
-
-class ArticleDetailByIdOrSlugAPIView(APIView):
-    """
-    Retrieve an article by numeric ID or slug string.
-    """
-
-    permission_classes = [CanViewArticle]  # Change if public access is allowed
-
     @extend_schema(
         summary="Retrieve article by ID or slug",
-        description="If the parameter is numeric, retrieve by ID. Otherwise, slug.",
+        description="If the path parameter is numeric → ID, else → slug.",
         parameters=[
             OpenApiParameter(
                 name="identifier",
-                description="Article ID (number) or slug (string)",
-                required=True,
                 type=str,
                 location=OpenApiParameter.PATH,
-            ),
+                description="Article ID (number) or slug (string)",
+                required=True,
+            )
         ],
-        responses={
-            200: RichTextArticleSerializer,
-            404: OpenApiResponse(description="Not found"),
-        },
+        responses={200: RichTextArticleSerializer, 404: OpenApiResponse()},
     )
-    def get(self, request, identifier):
-        qs = Article.objects.all()
-
-        # Admins/staff/groups see everything
-        if not (is_admin_user(request) or is_article_group_user(request)):
-            qs = qs.filter(is_published=True)
+    @action(
+        detail=False,
+        methods=["get"],
+        url_path="detail/(?P<identifier>[^/.]+)",
+        url_name="detail-by-id-or-slug",
+    )
+    def detail_by_id_or_slug(self, request, identifier):
+        qs = self.get_queryset()
 
-        # Check if numeric → ID
         if identifier.isdigit():
             article = get_object_or_404(qs, id=int(identifier))
         else:
             article = get_object_or_404(qs, slug=identifier)
 
-        serializer = RichTextArticleSerializer(article, context={"request": request})
+        serializer = self.get_serializer(article)
         return Response(serializer.data, status=status.HTTP_200_OK)
 
 

articles/views_test.py

@@ -1,12 +1,9 @@
 """Test for articles views"""
 
-import pytest
-from rest_framework.reverse import reverse
 import pytest
 from rest_framework.reverse import reverse
 
 from articles.models import Article
-
 from main.factories import UserFactory
 
 pytestmark = [pytest.mark.django_db]
@@ -26,16 +23,6 @@ def test_article_creation(staff_client, user):
     assert json["title"] == "Some title"
 
 
-@pytest.mark.parametrize("is_staff", [True, False])
-def test_article_permissions(client, is_staff):
-    user = UserFactory.create(is_staff=True)
-    client.force_login(user)
-    url = reverse("articles:v1:articles-list")
-    resp = client.get(url)
-    resp.json()
-    assert resp.status_code == 200 if is_staff else 403
-
-
 def test_retrieve_article_by_id(client, user):
     """Should retrieve published article by numeric ID"""
     article = Article.objects.create(
@@ -46,7 +33,7 @@ def test_retrieve_article_by_id(client, user):
     )
 
     url = reverse(
-        "articles:v1:article-detail-by-id-or-slug",
+        "articles:v1:articles-detail-by-id-or-slug",
         kwargs={"identifier": str(article.id)},
     )
 
@@ -68,7 +55,7 @@ def test_retrieve_article_by_slug(client, user):
     )
 
     url = reverse(
-        "articles:v1:article-detail-by-id-or-slug",
+        "articles:v1:articles-detail-by-id-or-slug",
         kwargs={"identifier": article.slug},
     )
 
@@ -93,7 +80,7 @@ def test_staff_can_access_unpublished_article(client):
     )
 
     url = reverse(
-        "articles:v1:article-detail-by-id-or-slug",
+        "articles:v1:articles-detail-by-id-or-slug",
         kwargs={"identifier": str(article.id)},
     )
 

frontends/api/src/generated/v1/api.ts

@@ -127,7 +127,7 @@ paths:
   /api/v1/articles/detail/{identifier}/:
     get:
       operationId: articles_detail_retrieve
-      description: If the parameter is numeric, retrieve by ID. Otherwise, slug.
+      description: If the path parameter is numeric → ID, else → slug.
       summary: Retrieve article by ID or slug
       parameters:
       - in: path
@@ -146,7 +146,7 @@ paths:
                 $ref: '#/components/schemas/RichTextArticle'
           description: ''
         '404':
-          description: Not found
+          description: No response body
   /api/v1/content_file_search/:
     get:
       operationId: content_file_search_retrieve