## Table Of Contents * [Create model](#chapter-1) * [Create frontend](#chapter-2) * [Create API](#chapter-3) ### Create model We type in base dir: ``` python manage.py startapp stocks ``` Register app in settings.py: ``` INSTALLED_APPS = [ ... 'stocks', ] ``` We write initial model in "models.py": ``` from django.db import models class Stock(models.Model): id = models.AutoField(primary_key=True) name = models.CharField(max_length=128) price = models.FloatField() created = models.DateTimeField(auto_now_add=True) update = models.DateTimeField(auto_now=True) class Meta: verbose_name = "stock" verbose_name_plural = "stocks" ordering = ['-id', ] def __str__(self): return self.name ``` Apply migrations: ``` python manage.py makemigrations python manage.py migrate ``` Create your ModelAdmin: ``` from django.contrib import admin from django.contrib.admin import register from stocks.models import Stock @register(Stock) class StockAdmin(admin.ModelAdmin): list_display = ['id', 'name', 'price', 'update'] ``` Then you should be see something like this in your django admin: ![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/l7b1bscn89mqrvraebzl.PNG) ### Create frontend Create a ModelForm for after render it. Create new file "forms.py". ``` from django import forms from .models import Stock class StockForm(forms.ModelForm): class Meta: model = Stock fields = ['name', 'price'] ``` Now, we should create a CRUD views in file "views.py" (note , i add staff authentication required in update, create and delete but not is list amd not in detail): ``` from django.urls import reverse_lazy from django.views.generic import ListView, DetailView, CreateView, UpdateView, DeleteView from .models import Stock from .forms import StockForm from django.utils.decorators import method_decorator from django.contrib.admin.views.decorators import staff_member_required class StockListView(ListView): model = Stock paginate_by = 2 # change it, is page size def get_queryset(self): query = self.request.GET.get('q') if query: object_list = self.model.objects.filter(name__icontains=query) else: object_list = self.model.objects.all() return object_list class StockDetailView(DetailView): model = Stock @method_decorator(staff_member_required, name='dispatch') class StockCreate(CreateView): model = Stock form_class = StockForm template_name_suffix = '_create_form' success_url = reverse_lazy('stocks:list') @method_decorator(staff_member_required, name='dispatch') class StockUpdate(UpdateView): model = Stock form_class = StockForm template_name_suffix = '_update_form' def get_success_url(self): return reverse_lazy('stocks:update', args=(self.object.id, )) + '?ok' @method_decorator(staff_member_required, name='dispatch') class StockDelete(DeleteView): model = Stock success_url = reverse_lazy('stocks:list') ``` We connect this views to url paths (create "urls.py"): ``` from django.urls import path from .views import StockListView, StockDetailView, StockCreate, StockUpdate, StockDelete stocks_patterns = ([ path('', StockListView.as_view(), name='list'), path('//', StockDetailView.as_view(), name='detail'), path('create/', StockCreate.as_view(), name='create'), path('update/', StockUpdate.as_view(), name='update'), path('delete/', StockDelete.as_view(), name='delete'), ], 'stocks') ``` In settings.urls we add: ``` ... from stocks.urls import stocks_patterns ... urlpatterns = [ ... path('stocks/', include(stocks_patterns)), ... ] ``` This CRUD views need next 5 templates: - stocks/templates/stocks/stock_list.html - stocks/templates/stocks/stock_detail.html - stocks/templates/stocks/stock_create_form.html (custom prefix) - stocks/templates/stocks/stock_update_form.html (custom prefix) - stocks/templates/stocks/stock_confirm_delete.html stocks/templates/stocks/stock_list.html: ``` {% extends 'core/base.html' %} {% load static %} {% block title %}Stocks{% endblock %} {% block content %} {% if stock_list|length == 0 %} No se han encontrado resultados. Create {% endif %} {% for stock in stock_list %}

{% endfor %} {% if stock_obj.paginator.num_pages > 1 %} {% endif %} {% endblock %} ``` stocks/templates/stocks/stock_detail.html: ``` {% extends 'core/base.html' %} {% load static %} {% block title %}{{object.name}}{% endblock %} {% block content %}

name: {{object.name|safe}}
price: {{object.price}}
{% if request.user.is_staff %}

Editar

{% endif %}

{% endblock %} ``` stocks/templates/stocks/stock_create_form.html: ``` {% extends 'core/base.html' %} {% load bulma_tags %} {% load static %} {% block title %}Create{% endblock title %} {% block content %}

Volver

{% endblock content %} ``` stocks/templates/stocks/stock_update_form.html: ``` {% extends 'core/base.html' %} {% load bulma_tags %} {% load static %} {% block title %}Update{% endblock title %} {% block content %} {% if 'ok' in request.GET %}

Actualizado

Updated. more details here.

{% endif %}

Volver

{% endblock content %} ``` stocks/templates/stocks/stock_confirm_delete.html: ``` {% extends 'core/base.html' %} {% load static %} {% block title %}{{object.name}}{% endblock %} {% block content %}

{% endblock %} ``` I use 'core/base.html' from django-bulma. Here the result: ![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/p9ijpub4rz45d40exza8.PNG) We have search, pagination, edit form, create form and delete. All this, with minimal code and very customizable. ### Create API For expose this model to API REST, we use django restframework and django-filter: ``` $ pip install djangorestframework $ pip install django-filter ``` And register it in settings: ``` INSTALLED_APPS = [ ... 'rest_framework', 'django_filters', ] ``` For convert model to json, or json to model we need create "serializers.py" file, and type: ``` from rest_framework import serializers from .models import Stock class StockSerializer(serializers.ModelSerializer): class Meta: model = Stock fields = '__all__' ``` For create a API Rest that let "filter" and "order" for someone field of model. We create "filters.py" and type: ``` import django_filters from .models import Stock class StockFilter(django_filters.FilterSet): id = django_filters.NumberFilter() name = django_filters.CharFilter(lookup_expr='iexact') price = django_filters.CharFilter(lookup_expr='eq') order = django_filters.OrderingFilter(fields=('name', 'price', )) class Meta: model = Stock fields = '__all__' ``` Finally, we need create a API View using your serializer and your filter. We create "viewsets.py" and type: ``` from rest_framework import viewsets from .models import Stock from .serializers import StockSerializer from .filters import StockFilter class StockViewSet(viewsets.ModelViewSet): queryset = Stock.objects.all() serializer_class = StockSerializer filterset_class = StockFilter ``` Now, we are registering this viewset in settings.router: ``` from rest_framework import routers from stocks.viewsets import StockViewSet router = routers.DefaultRouter() router.register('stocks', StockViewSet) urlpatterns = [ ... path('api/v1/', include(router.urls)), ... ] ``` Maybe you need a good config for restframework.auth. Using JWT, Cookies, or whatever you want. The API (is full CRUD + filters) is available in: http://localhost:8000/api/v1/stocks/ I recommend "drf-spectacular" for generate API documentation in swagger, or redoc format. I hope this is useful for someone. Greats. Ricardo. Follow me for more content.

makiolo

Django model + Frontend CRUD + pagination + API REST and filters by Example

Join Our Newsletter. No Spam, Only the good stuff.