Added more views examples

Author: avara1986

Pipfile

@@ -5,8 +5,7 @@ name = "pypi"
 
 [packages]
 django = ">=3.0.2"
-djangorestframework = ">=3.11.0"
-django-rest-swagger = "==2.2.0"
+djangorestframework = "==3.11.0"
 django-opentracing = ">=1.1.0"
 jaeger-client = ">=4.3.0"
 

Pipfile.lock

@@ -16,18 +16,4 @@ Create and push the image
 
 Test the image:
 
-    docker run -d -p 8000:8000 templatedjango
-    
-    
-Push to Kubernetes:
-
-    kubectl create -f service.yaml
-    
-    
-## How to contrib
-
-TODO
-
-### Update docs
-
-   sphinx-build -b html docs/ _build
+    docker run -d -p 8000:8000 templatedjango

README.md

@@ -41,7 +41,7 @@
     'django.contrib.staticfiles',
     'django_opentracing',
     'rest_framework',
-    'rest_framework_swagger',
+    'rest_framework.authtoken',
     'template',
 ]
 

project/settings.py

@@ -12,23 +12,28 @@
 Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+
+Try a private URL
+curl -X POST http://127.0.0.1:8000/api-token-auth/ -d '{"username": "admin", "password": "test1234"}' -H "Content-Type: application/json"
+curl -X GET http://127.0.0.1:8000/example-private/ -H 'Authorization: Token 3f8c6c1ed1eec35a59785f6d1963bf69ac633119'
 """
 from django.contrib import admin
 from django.urls import path, include
 from rest_framework import routers
-from rest_framework_swagger.views import get_swagger_view
+from rest_framework.authtoken import views
 
-from template.views import ColorViewSet
+from template.views import ColorViewSet, ColorList, ColorDetail, ExampleView
 
 # Routers provide an easy way of automatically determining the URL conf.
 router = routers.DefaultRouter()
 router.register('template', ColorViewSet)
 
-schema_view = get_swagger_view(title='Template API')
-
 urlpatterns = [
     path('admin/', admin.site.urls),
-    path('', schema_view),
+    path('template2/', ColorList.as_view()),
+    path('template2/<str:pk>/', ColorDetail.as_view()),
+    path('example-private/', ExampleView.as_view()),
     path('', include(router.urls)),
+    path('api-token-auth/', views.obtain_auth_token),
     path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
 ]

project/urls.py

@@ -1,6 +1,5 @@
-# Generated by Django 3.0.2 on 2020-01-17 19:44
+# Generated by Django 3.0.2 on 2020-01-19 12:12
 
-import datetime
 from django.db import migrations, models
 import uuid
 
@@ -18,9 +17,9 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('idpublic', models.UUIDField(default=uuid.uuid4, editable=False, verbose_name='Número de referencia')),
+                ('timestamp', models.DateTimeField(auto_now_add=True)),
                 ('name', models.CharField(max_length=30)),
                 ('last_name', models.CharField(max_length=30)),
-                ('timestamp', models.DateTimeField(default=datetime.datetime.now)),
             ],
             options={
                 'db_table': 'colors',

template/migrations/0001_initial.py

@@ -3,8 +3,34 @@
 from template.models import Color
 
 
-# Serializers define the API representation.
-class ColorSerializer(serializers.HyperlinkedModelSerializer):
+class ColorModelSerializer(serializers.ModelSerializer):
+    """
+    Example with a ModelSerializer
+    """
+
     class Meta:
         model = Color
-        fields = ('id', 'name', 'timestamp')
+        fields = ('idpublic', 'name', 'timestamp')
+
+
+class ColorSerializer(serializers.Serializer):
+    """
+    Example with a Serializer
+    """
+    idpublic = serializers.CharField(read_only=True)
+    name = serializers.CharField(required=True, allow_blank=False, max_length=100)
+    timestamp = serializers.DateTimeField(read_only=True)
+
+    def create(self, validated_data):
+        """
+        Create and return a new `Color` instance, given the validated data.
+        """
+        return Color.objects.create(**validated_data)
+
+    def update(self, instance, validated_data):
+        """
+        Update and return an existing `Color` instance, given the validated data.
+        """
+        instance.name = validated_data.get('name', instance.name)
+        instance.save()
+        return instance