Adding Transactions

[brukeg]

cc @AshMudra for visibility. Here's what I'm following: https://blog.logrocket.com/django-rest-framework-create-api/, and what I'm going to work on this week.

Setup To Do:

• add 'rest_framework' to INSTALLED_APPS
• pip install django_rest_framework
• pip freeze > requirements.txt # add django_rest_framework to requirements.txt
• create serializers.py in api/bonebudget/..
• add path('api-auth/', include('rest_framework.urls')), to api/api/urls.py
• python manage.py createsuperuser

Endpoint: bonebudget/transaction/

• GET: List all transactions for requested user
• POST: Add a new transaction

Endpoint: bonebudget/transaction/<uid:transaction_id>

• GET: Retrieve transaction with given transaction_id
• PUT: Update a transaction with given transaction_id
• DELETE: Delete a transaction with given transaction_id

Models To Do:

• Add below to models.Transaction

  def __str__(self):
  return self.description

• python manage.py makemigrations & python manage.py migrate

• Convert Model object to an API-appropriate format using ModelSerializer class. In api/bonebudget/serializers.py:

  • 
    from rest_framework import serializers
    from .models import Transaction
    
    class TransactionSerializer(serializers.ModelSerializer):
       class Meta:
           model = Transaction
           fields = [
               "id", "user_id", "is_credit", "transaction_type", "amount", "posted_date", "status", "description", "created_at", "updated_at"
           ]

Views To Do:

• Import:

  from rest_framework.views import APIView
  from rest_framework.response import Response
  from rest_framework import status
  from rest_framework import permissions  # authenticated users only
  from .models import Transaction
  from .serializers import TransactionSerializer

transactions/api/:

• Create TransactionView class in api/bonebudget/views.py

class TransactionView(APIView):
    permission_classes = [permissions.IsAuthenticated]

    def get(self):
        pass  # add logic here

    def post(self):
        pass  # add logic here

• Create an endpoint for the class-based view in api/bonebudget/urls.py:

  • import:

    from .views import (
    TransactionView,
    )

• add a url to api/bonebudget/urls.py:

  urlpatterns = [
  path('api', TransactionView.as_view()),
  ]

• python manage.py runserver

• Navigate to http://127.0.0.1:8000/transaction/api/ to test.

• Try to add a transaction:

  {
  "description": "barebones buritto",
  "is_credit": false,
  "amount": 8.0,
  "transaction_type": "credit card",
  "status": "pending"
  }

transaction/api/:

• Create transaction detail view in api/bonebudget/views.py

class TransactionDetailView(APIView):
    permission_classes = [permissions.IsAuthenticated]

    def get_object(self):
    """Helper method"""
        pass  # add logic here

    def get(self):
        pass  # add logic here

    def put(self):
        pass  # add logic here

    def delete(self):
        pass  # add logic here

• Add a url to api/bonebudget/urls.py

  path('api/<uid: transaction_id>/', TransactionDetailView.as_view()),

• Import:

  from .views import (
  TransactionView, TransactionDetailView
  )

• navigate to http://127.0.0.1:8000/transactions/bonebudget// to test using a valid transaction_id.

[brukeg]

Done!