GitLocker: The Coding Marketplace

Description:

djangodansapitoolkit 1.0.2

Django Dans API Toolkit

Description
Django Dans API Toolkit is a Django app to help make building APIs great.
It provides a collection of tools for common API tasks, intended to complement Django Rest Framework (DRF) rather than replace it.
Available on PyPi
Features
The toolkit includes:

API Response Handler (api_response_handler.py): Standardizes API response formats.
API Response Renderer (api_response_renderer.py): Ensures consistent response rendering across your APIs.
Base Serializer (serializers/base.py): Simplifies serializer creation with masking and reference functionality.

Quick Start
Installation

Install the package via pip:
pip install django-dans-api-toolkit

Add django_dans_api_toolkit to your INSTALLED_APPS setting:
INSTALLED_APPS = [
...
'django_dans_api_toolkit',
]

Run migrations to update your database schema:
python manage.py migrate

Use the provided tools in your views and serializers.

Example Usage
API Response Handler
from django_dans_api_toolkit.api_response_handler import ApiResponseHandler

def my_view(request):
handler = ApiResponseHandler()
data = {"key": "value"}
return handler.response_success(results=data)

Base Serializer
from django_dans_api_toolkit.serializers.base import BaseSerializer
from myapp.models import MyModel

class MyModelSerializer(BaseSerializer):
class Meta:
model = MyModel
fields = '__all__'
ref_fields = ['field1', 'field2']
masked_fields = ['field3']

API Response Renderer
Ensure DEFAULT_AUTHENTICATION_CLASSES and DEFAULT_PAGINATION_CLASS are set in your settings.py for proper API functionality. Set the renderer itself as well.
Example configuration:
REST_FRAMEWORK = {
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
"PAGE_SIZE": 20,
"DEFAULT_AUTHENTICATION_CLASSES": (
"rest_framework.authentication.TokenAuthentication",
),
}

Requirements

Python 3.10 - 3.11
Django 3.1 or higher
Django Rest Framework

NOTE: not only must you have this installed, you must have set DEFAULT_AUTHENTICATION_CLASSES and DEFAULT_PAGINATION_CLASS in your settings.py to work with the APIs properly. An example config would be:

https://danielnazarian.com
Copyright 2024 © Daniel Nazarian.