delivery api

API Pengiriman

Selamat datang di API Pengiriman! API ini adalah solusi untuk mengelola produk dan penjualan di aplikasi Anda. Dibangun dengan .NET, ini menyediakan antarmuka yang tenang untuk membuat dan mengelola produk dan memproses transaksi penjualan. Dokumen ini memberikan gambaran umum tentang titik akhir API pengiriman, termasuk deskripsi terperinci, parameter permintaan, dan format respons. API mencakup titik akhir untuk pemeriksaan kesehatan, mengelola produk, dan menangani penjualan.

---

Bagaimana menjalankan

1. Klon Repositori:

   git clone https://github.com/anthonyvii27/delivery-api

2. Ubah ke direktori repositori:

    cd delivery-api

3. Jalankan perintah untuk memulai lingkungan yang dimasukkan:

   make compose-up-v2

4. API akan berjalan di port :8080 di komputer Anda.

5. Secara opsional, di root repositori ini, ada file bernama delivery-api.http yang menyediakan antarmuka yang mudah digunakan untuk melaksanakan titik akhir yang diimplementasikan.

---

Titik akhir

Pemeriksaan kesehatan

GET /health

Ringkasan : Memeriksa status kesehatan API.

Tanggapan :

• 200 OK

   " Database connection is healthy. "

• 503 Layanan tidak tersedia

   " Database connection isn't available. "

• 500 kesalahan server internal

   " An error occurred while checking the database connection. "

---

Produk

GET /products

Ringkasan : Mengambil semua produk.

Tanggapan :

• 200 OK

  [
    {
      "id" : 1 ,
      "name" : " Product Name " ,
      "unitOfMeasurement" : " UN " ,
      "price" : 9.99
    }
  ]

---

GET /products/{id}

Ringkasan : Mengambil produk dengan ID -nya.

Parameter :

• Jalur :
  • id (Integer): ID produk untuk diambil.

Tanggapan :

• 200 OK

   {
     "id" : 1 ,
     "name" : " Product Name " ,
     "unitOfMeasurement" : " UN " ,
     "price" : 9.99
   }

• 404 tidak ditemukan

  {
    "message" : " Product with ID {id} not found. "
  }

---

POST /products

Ringkasan : Membuat produk baru.

Badan Permintaan :

{
  "name" : " Product Name " ,
  "unitOfMeasurement" : " Unit " ,
  "price" : 9.99
}

Tanggapan :

• 201 dibuat

  {
    "id" : 1 ,
    "name" : " Product Name " ,
    "unitOfMeasurement" : " Unit " ,
    "price" : 9.99
  }

• 400 permintaan buruk

  {
    "message" : " Validation error messages "
  }

---

PUT /products/{id}

Ringkasan : memperbarui produk yang ada.

Parameter :

• Jalur :
  • id (Integer): ID produk yang akan diperbarui.

Badan Permintaan :

{
  "name" : " Updated Product Name " ,
  "unitOfMeasurement" : " Updated Unit " ,
  "price" : 9.99
}

Tanggapan :

• 200 OK

  {
    "id" : 1 ,
    "name" : " Updated Product Name " ,
    "unitOfMeasurement" : " Updated Unit " ,
    "price" : 9.99
  }

• 400 permintaan buruk

  {
    "message" : " Validation error messages "
  }

• 404 tidak ditemukan

  {
    "message" : " Product with ID {id} not found. "
  }

---

DELETE /products/{id}

Ringkasan : Menghapus produk dengan ID -nya.

Parameter :

• Jalur :
  • id (Integer): ID produk yang akan dihapus.

Tanggapan :

• 204 tidak ada konten

• 400 permintaan buruk

  {
    "message" : " Error message "
  }

• 404 tidak ditemukan

  {
    "message" : " Product with ID {id} not found. "
  }

• 409 Konflik

  {
    "message" : " Cannot delete the product as it has associated sale items. "
  }

---

Penjualan

GET /sales

Ringkasan : Mengambil semua penjualan (bersejarah).

Tanggapan :

• 200 OK

  [
    {
      "id" : 1 ,
      "saleDate" : " 2024-08-14T00:00:00Z " ,
      "totalAmount" : 100.00 ,
      "saleItems" : [
        {
          "id" : 1 ,
          "productId" : 1 ,
          "quantity" : 2 ,
          "unitPrice" : 50.00
        }
      ]
    }
  ]

---

GET /sales/{id}

Ringkasan : Mengambil penjualan dengan ID -nya.

Parameter :

• Jalur :
  • id (Integer): ID penjualan untuk mengambil.

Tanggapan :

• 200 OK

  {
    "id" : 1 ,
    "saleDate" : " 2024-08-14T00:00:00Z " ,
    "totalAmount" : 100.00 ,
    "saleItems" : [
      {
        "id" : 1 ,
        "productId" : 1 ,
        "quantity" : 2 ,
        "unitPrice" : 50.00
      }
    ]
  }

• 404 tidak ditemukan

  {
    "message" : " Sale with ID {id} not found. "
  }

---

POST /sales

Ringkasan : Membuat penjualan baru.

Badan Permintaan :

{
  "saleDate" : " 2024-08-14T00:00:00Z " ,
  "zipCode" : " 12345678 " ,
  "saleItems" : [
    {
      "productId" : 1 ,
      "quantity" : 2
    }
  ]
}

Tanggapan :

• 201 dibuat

  {
    "id" : 1 ,
    "saleDate" : " 2024-08-14T00:00:00Z " ,
    "totalAmount" : 100.00 ,
    "saleItems" : [
      {
        "id" : 1 ,
        "productId" : 1 ,
        "quantity" : 2 ,
        "unitPrice" : 50.00 ,
        "product" : {
          "id" : 1 ,
          "name" : " Product Name " ,
          "unitOfMeasurement" : " Unit " ,
          "price" : 50.00
        }
      }
    ]
  }

• 400 permintaan buruk

  {
    "message" : " Validation error messages "
  }

---

DELETE /sales/{id}

Ringkasan : menghapus (membatalkan) penjualan berdasarkan ID -nya.

Parameter :

• Jalur :
  • id (Integer): ID penjualan untuk menghapus.

Tanggapan :

• 204 tidak ada konten

• 400 permintaan buruk

  {
    "message" : " Error message "
  }

• 404 tidak ditemukan

  {
    "message" : " Sale with ID {id} not found. "
  }