django-small-view-set 0.1.4

A lightweight Django ViewSet alternative with minimal abstraction.

Django Small View Set

A lightweight Django ViewSet alternative with minimal abstraction. This library provides a simple and transparent way to define API endpoints without relying on complex abstractions.

Getting Started with Django Small View Set

This guide provides a simple example to get started with the library.

Example Usage

Here’s how you can define a basic API endpoint with one collection route and one detail route:

import asyncio
from django.http import JsonResponse
from django.urls import path
from small_view_set.small_view_set import SmallViewSet, default_handle_endpoint_exceptions, disable_endpoint

class BarViewSet(SmallViewSet):

    def urlpatterns(self):
        return [
            path('api/bars/',          self.default_router, name='bars_collection'),
            path('api/bars/items/',    self.items, name='bars_items'),
            path('api/bars/<int:pk>/', self.default_router, name='bars_detail'),
        ]

    @default_handle_endpoint_exceptions
    def list(self, request):
        self.protect_list(request)
        return JsonResponse({"message": "Hello, world!"}, status=200)

    @default_handle_endpoint_exceptions
    @disable_endpoint
    async def items(self, request):
        self.protect_list(request)
        await asyncio.sleep(1)
        return JsonResponse({"message": "List of items"}, status=200)

    @default_handle_endpoint_exceptions
    def patch(self, request, pk):
        self.protect_update(request)
        return JsonResponse({"message": f"Updated {pk}"}, status=200)

    @default_handle_endpoint_exceptions
    async def retrieve(self, request, pk):
        self.protect_retrieve(request)
        return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)

Registering in urls.py

To register the viewset in your urls.py:

from api.views.bar import BarViewSet

urlpatterns = [
    # Other URLs like admin, static, etc.

    *BarViewSet().urlpatterns(),
]

Documentation

• Custom Endpoints: Learn how to define custom endpoints alongside the default router.
• Handling Endpoint Exceptions: Understand how to write your own decorators for exception handling.
• Custom Protections: Learn how to subclass SmallViewSet to add custom protections like logged-in checks.
• DRF Compatibility: Learn how to use some of Django Rest Framework's tools, like Serializers.
• Disabling an endpoint: Learn how to disable an endpoint without needing to delete it or comment it out.
• Reason: Reasoning behind this package.