API CRUD FOR SALES APP

Using DRF, JWT Auth, Django, Postgres

Tables of content

Setup
Models
Add authen
API: GET, POST, DELETE, PUT
Unit-Testing
Front-end

Setup

Enviroment

pip install virtualenv
virtualenv <yourfolder>
cd <yourfolder>
scripts\activate
git clone https://github/tangoc2712/apicrud
pip install -r requirements.txt

Project

python manage.py migrate
python manage.py makemigrations
python createsuperuser

Create Models

Define model name Order, we're working with one simple table include some fields:

date (date)
item (char)
price (decimal)
quantity (decimal)
amount (decimal)

Add authentication

We using Simple-JWT for auth

First, add config to REST_FRAMEWORK in settings.py
Next in your root urls.py file (or any other url config), include routes for Simple JWT’s TokenObtainPairView and TokenRefreshView views

To verify it's working, we can use curl or hit on http://127.0.0.1:8000/api/token/ to issue a couple of test requests (username and password from your superuser):

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "1"}' \
  http://127.0.0.1:8000/api/token/

You'll recieve response look like this

HTTP 200 OK
Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept
{
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY0NjI1MzYxOCwianRpIjoiYjMzMDM2ZmVkY2ZhNDQ2ZmIzNjc1ZGEzZTgyZjY0MjUiLCJ1c2VyX2lkIjoxfQ.TM5Z0rPG0Zq33T4iY7euJwovF7TGxwHxRNNqU5h9duo",
    "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ2NzcyMDE4LCJqdGkiOiIyNWE1Zjk1NzQwYTQ0NmY1YTdjMTU0YjczM2M2NDhlNCIsInVzZXJfaWQiOjF9.E8JXvDD9gh7VZMSXfGbBsBm8lI-8Hw8n38aF9LGB_ro"
}

API: GET, POST, DELETE, PUT

Create serializers.py file to serialized Order Model
Next create api_view in views.py include function-views: orders and orders
function save_order() has to validate some fields as date, quantity, price, item
Next, routing for views

Unit-testing

We have 6 test case:

add order without token
add order with token
add order wrong data (check save_order() function)
add order with caculate amount
get order
put order then delete

We also test with Postman or curl command, ...

Front-end

License

MIT

tangoc2712/sales