An APIView to handles its model endpoints
Project description
Django_APIView
Implement a base generic view for handling model RESTful endpoints
Usage
# models.py
from django.db import models
from django_modelapiview import JSONMixin
class MyModel(JSONMixin, models.Model):
"""
Declare your model as you usually do but
add a json_fields list
"""
json_fields:list[str] = ['text', 'image', 'fk', 'fk_reverse', 'm2m', 'my_method']
text = models.TextField()
image = models.ImageField()
fk = models.ForeignKey(...)
# fk_reverse
m2m = models.ManyToManyField(...)
def my_method(self):
return "my custom value"
# views.py
from django_modelapiview import APIView
from .models import MyModel
class MyView(APIView):
# Required
model:JSONMixin = MyModel # Your model
route:str = "mymodels" # The url to access your collection
# Optional
queryset:QuerySet = MyModel.objects.all() # A custom base queryset (will be affected by query filters)
singular_name:str = "my model" # Singular name of your model for reason message
plural_name:str = "my models" # Plural name of your model for reason message
http_method_names:list[str] = ['head', 'get', 'patch', 'post'] # The list of HTTP method names that this view will accept.
enforce_authentification:bool = True # Should this model be restricted with Token access
query_parameters:list[tuple[str, Callable[[QuerySet, object], QuerySet]]] = [
('order_by', lambda queryset, field_names: queryset.order_by(*field_names.split(",")) if field_names else queryset),
('limit', lambda queryset, limit: queryset[:int(limit)] if limit else queryset), # Should be last since sliced QuerySet can't be filtered anymore
]
# urls.py
from django.urls import path, include
from . import views
urlpatterns = [
path("", include("django_routeview")), # Django RouteView are used as based class for APIView in order to automatically register them
]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django_modelapiview-1.3.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59efe8cc5ddcdcb1ae9861026c49bf4ec3df3078a160b34b3b75005036f4509d |
|
MD5 | b98df24d7f96f804255928f5149b697b |
|
BLAKE2b-256 | 9c63c95ee17ceed88d505b8964a90124f1ea06e26fcedb09ffd712677584a804 |
Close
Hashes for django_modelapiview-1.3.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54dbcf7eeb315707039fdbd70f3db1522c9d014362b3227e811d0a615abe904e |
|
MD5 | b8e5accc3ed62870dc5825007a58b15b |
|
BLAKE2b-256 | 914920abe126fda81adf5ed08ad4a386da2a9bc275dbccc76ddabe5d50657cb8 |