API testing and Project Structure/Flow

This guide explains how to test API endpoints using Postman. The API supports CRUD (Create, Read, Update, Delete) operations on a dataset.

---

Created by: Ashish kumar | github: https://github.com/ashishkumar30

**Data is already in Databse

🚀 The logger is activated in this setup. Please check the logs in the logfile at logs/gloroots_app.log

🚀 Please find attached a screenshot of the API testing and response in the Image folder.

Django Project Details

Project Name: gloroots

Project Structure:

├── app_crud_operations
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── crud_controller.py
│   ├── migrations
│   ├── models.py
│   ├── response_json.py
│   ├── serializers.py
│   ├── tests.py
│   ├── urls.py
│   ├── views.py
├── db.sqlite3
├── gloroots
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
├── logs
│   ├── gloroots_app
│   └── gloroots_app.log
├── manage.py
└── test.py

---

Setting up the Project

1️⃣ Activate Virtual Environment (if Available)

python -m venv venv  # Create a virtual environment
source venv/bin/activate  # Activate on macOS/Linux
venv\Scripts\activate  # Activate on Windows

2️⃣ Install Dependencies

pip install -r requirements.txt

3️⃣ Run the Django Server

python manage.py runserver 8000

4️⃣ Run test.py for Backend CRUD Testing

python test.py

Alternatively, you can manually test endpoints using Postman.

---

Prerequisites

• Install Postman
• Ensure the API server is running at http://127.0.0.1:8000

---

API Endpoints

1️⃣ CREATE (POST)

• URL: http://127.0.0.1:8000
• Method: POST
• Headers:
  • Content-Type: application/json
  • unloc: unlocs
• Body: Raw JSON from GitHub Data

Example Request Body:

{
  "AEAJM": {
    "name": "Ajman",
    "city": "Ajman",
    "country": "United Arab Emirates",
    "coordinates": [55.5136433, 25.4052165],
    "province": "Ajman",
    "timezone": "Asia/Dubai",
    "unlocs": ["AEAJM"],
    "code": "52000"
  }
}

Example Response:

{
  "Status_code": 201,
  "Status": "Success",
  "Message": "New Data Created",
  "Data": [{
    "un_location_code_id": "AEAJM",
    "name": "Ajman",
    "city": "Ajman",
    "country": "United Arab Emirates",
    "coordinates": [55.5136433, 25.4052165],
    "province": "Ajman",
    "timezone": "Asia/Dubai",
    "code": "52000",
    "unlocs": ["AEAJM"]
  }]
}

---

2️⃣ READ (GET)

• URL: http://127.0.0.1:8000?unloc=AOSZA
• Method: GET
• Headers:
  • Content-Type: application/json
  • unloc: XLDSSS

Example Response:

{
  "XLDSSS": {
    "name": "ASHISH",
    "city": "ASHISH",
    "country": "United Arab Emirates",
    "coordinates": [55.5136433, 25.4052165],
    "province": "Ajman",
    "timezone": "Asia/Dubai",
    "unlocs": ["AEAJM"],
    "code": "52000"
  }
}

• Response: Returns requested data based on unloc in headers.
• Response: Returns all data if unloc is not passed.

---

3️⃣ UPDATE (PATCH)

• URL: http://127.0.0.1:8000?unloc=AEDXB
• Method: PATCH
• Headers:
  • Content-Type: application/json
  • unloc: AEDXB

Example Request Body:

{
  "AEDXB": {
    "name": "ASHISH",
    "city": "ASHISH",
    "country": "United Arab Emirates",
    "coordinates": [55.5136433, 25.4052165],
    "province": "Ajman",
    "timezone": "Asia/Dubai",
    "unlocs": ["AEAJM"],
    "code": "52000"
  }
}

Example Response:

{
  "Status_code": 201,
  "Status": "Success",
  "Message": "Data inserted successfully",
  "Data": {
    "un_location_code_id": "AEDXB",
    "name": "ASHISH",
    "city": "ASHISH",
    "country": "United Arab Emirates",
    "coordinates": [55.5136433, 25.4052165],
    "province": "Ajman",
    "timezone": "Asia/Dubai",
    "code": "52000",
    "unlocs": ["AEAJM"]
  }
}

---

4️⃣ DELETE (DELETE)

• URL: http://127.0.0.1:8000?unloc=ESCAR
• Method: DELETE
• Headers:
  • unloc: AEDXB

Example Response:

{
  "Status_code": 204,
  "Status": "Success",
  "Message": "Location with UN location 'ESCAR' deleted successfully",
  "Data": null
}

---