Rewrite schema generation (#1)
* Completeley rewritten schema generation * Added support for python 2.7 and 3.4 * Restructured testing and build configuration * Added nested request schemas This rewrite completely replaces the public interface of the django rest schema generation library, so further changes will be needed to re-enable and further extend the customization points one might want.
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# Generated by Django 2.0 on 2017-12-05 04:05
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
initial = True
|
||||
|
||||
dependencies = [
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='Article',
|
||||
fields=[
|
||||
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('title', models.CharField(help_text='Main article headline', max_length=255, unique=True)),
|
||||
('body', models.TextField(help_text='Article content', max_length=5000)),
|
||||
('slug', models.SlugField(blank=True, help_text='Unique URL slug identifying the article', unique=True)),
|
||||
('date_created', models.DateTimeField(auto_now_add=True)),
|
||||
('date_modified', models.DateTimeField(auto_now=True)),
|
||||
('cover', models.ImageField(blank=True, upload_to='article/original/')),
|
||||
],
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,11 @@
|
||||
from django.db import models
|
||||
|
||||
|
||||
class Article(models.Model):
|
||||
title = models.CharField(help_text="title model help_text", max_length=255, blank=False, unique=True)
|
||||
body = models.TextField(help_text="article model help_text", max_length=5000, blank=False)
|
||||
slug = models.SlugField(help_text="slug model help_text", unique=True, blank=True)
|
||||
date_created = models.DateTimeField(auto_now_add=True)
|
||||
date_modified = models.DateTimeField(auto_now=True)
|
||||
|
||||
cover = models.ImageField(upload_to='article/original/', blank=True)
|
||||
@@ -0,0 +1,16 @@
|
||||
from rest_framework import serializers
|
||||
|
||||
from articles.models import Article
|
||||
|
||||
|
||||
class ArticleSerializer(serializers.ModelSerializer):
|
||||
class Meta:
|
||||
model = Article
|
||||
fields = ('title', 'body', 'slug', 'date_created', 'date_modified')
|
||||
read_only_fields = ('date_created', 'date_modified')
|
||||
lookup_field = 'slug'
|
||||
extra_kwargs = {'body': {'help_text': 'body serializer help_text'}}
|
||||
|
||||
|
||||
class ImageUploadSerializer(serializers.Serializer):
|
||||
upload = serializers.ImageField(help_text="image serializer help_text")
|
||||
@@ -0,0 +1,11 @@
|
||||
from django.conf.urls import include, url
|
||||
from rest_framework.routers import SimpleRouter
|
||||
|
||||
from articles import views
|
||||
|
||||
router = SimpleRouter()
|
||||
router.register('', views.ArticleViewSet)
|
||||
|
||||
urlpatterns = [
|
||||
url(r'^', include(router.urls)),
|
||||
]
|
||||
@@ -0,0 +1,60 @@
|
||||
import datetime
|
||||
|
||||
from django_filters.rest_framework import DjangoFilterBackend, filters
|
||||
from rest_framework import viewsets
|
||||
from rest_framework.decorators import detail_route, list_route
|
||||
from rest_framework.pagination import LimitOffsetPagination
|
||||
from rest_framework.parsers import MultiPartParser
|
||||
from rest_framework.response import Response
|
||||
|
||||
from articles import serializers
|
||||
from articles.models import Article
|
||||
|
||||
|
||||
class ArticleViewSet(viewsets.ModelViewSet):
|
||||
"""
|
||||
ArticleViewSet class docstring
|
||||
|
||||
retrieve:
|
||||
retrieve class docstring
|
||||
|
||||
destroy:
|
||||
destroy class docstring
|
||||
"""
|
||||
queryset = Article.objects.all()
|
||||
lookup_field = 'slug'
|
||||
serializer_class = serializers.ArticleSerializer
|
||||
|
||||
pagination_class = LimitOffsetPagination
|
||||
max_page_size = 5
|
||||
filter_backends = (DjangoFilterBackend, filters.OrderingFilter)
|
||||
filter_fields = ('title',)
|
||||
ordering_fields = ('date_modified',)
|
||||
ordering = ('username',)
|
||||
|
||||
@list_route(methods=['get'])
|
||||
def today(self, request):
|
||||
today_min = datetime.datetime.combine(datetime.date.today(), datetime.time.min)
|
||||
today_max = datetime.datetime.combine(datetime.date.today(), datetime.time.max)
|
||||
articles = self.get_queryset().filter(date_created__range=(today_min, today_max)).all()
|
||||
serializer = self.serializer_class(articles, many=True)
|
||||
return Response(serializer.data)
|
||||
|
||||
@detail_route(
|
||||
methods=['get', 'post'],
|
||||
parser_classes=(MultiPartParser,),
|
||||
serializer_class=serializers.ImageUploadSerializer,
|
||||
)
|
||||
def image(self, request, slug=None):
|
||||
"""
|
||||
image method docstring
|
||||
"""
|
||||
pass
|
||||
|
||||
def update(self, request, *args, **kwargs):
|
||||
"""update method docstring"""
|
||||
return super(ArticleViewSet, self).update(request, *args, **kwargs)
|
||||
|
||||
def destroy(self, request, *args, **kwargs):
|
||||
"""destroy method docstring"""
|
||||
return super(ArticleViewSet, self).destroy(request, *args, **kwargs)
|
||||
Reference in New Issue
Block a user