delivery api

Lieferapi

Willkommen bei der Lieferapi! Diese API ist eine Lösung für die Verwaltung von Produkten und Verkäufen in Ihrer Anwendung. Mit .NET erstellt, bietet es eine erholsame Schnittstelle zum Erstellen und Verwalten von Produkten und zur Verarbeitung von Verkaufstransaktionen. Dieses Dokument bietet einen Überblick über die Zustellungs -API -Endpunkte, einschließlich detaillierter Beschreibungen, Anforderungsparameter und Antwortformaten. Die API enthält Endpunkte für Gesundheitschecks, Verwaltung von Produkten und den Umsatz mit dem Umsatz.

---

Wie man rennt

1. Klonen Sie das Repository:

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

2. Wechseln Sie in das Repository -Verzeichnis:

    cd delivery-api

3. Führen Sie den Befehl aus, um die Containerumgebung zu starten:

   make compose-up-v2

4. Die API wird auf Port :8080 auf Ihrem Computer ausgeführt.

5. Optional gibt es im Stamm dieses Repository eine Datei mit dem Namen delivery-api.http , die eine benutzerfreundliche Schnittstelle für die Ausführung der implementierten Endpunkte bietet.

---

Endpunkte

Gesundheitsprüfung

GET /health

Zusammenfassung : Überprüft den Gesundheitszustand der API.

Antworten :

• 200 OK

   " Database connection is healthy. "

• 503 Service nicht verfügbar

   " Database connection isn't available. "

• 500 interner Serverfehler

   " An error occurred while checking the database connection. "

---

Produkte

GET /products

Zusammenfassung : Ruft alle Produkte ab.

Antworten :

• 200 OK

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

---

GET /products/{id}

Zusammenfassung : Ruft ein Produkt nach seiner ID ab.

Parameter :

• Weg :
  • id (Ganzzahl): Die ID des Produkts zum Abrufen.

Antworten :

• 200 OK

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

• 404 nicht gefunden

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

---

POST /products

Zusammenfassung : Erstellt ein neues Produkt.

Antragsbehörde :

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

Antworten :

• 201 erstellt

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

• 400 schlechte Anfrage

  {
    "message" : " Validation error messages "
  }

---

PUT /products/{id}

Zusammenfassung : Aktualisiert ein vorhandenes Produkt.

Parameter :

• Weg :
  • id (Ganzzahl): Die zu aktualisierende ID des Produkts.

Antragsbehörde :

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

Antworten :

• 200 OK

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

• 400 schlechte Anfrage

  {
    "message" : " Validation error messages "
  }

• 404 nicht gefunden

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

---

DELETE /products/{id}

Zusammenfassung : Löscht ein Produkt durch seine ID.

Parameter :

• Weg :
  • id (Ganzzahl): Die ID des Produkts zum Löschen.

Antworten :

• 204 Kein Inhalt

• 400 schlechte Anfrage

  {
    "message" : " Error message "
  }

• 404 nicht gefunden

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

• 409 Konflikt

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

---

Verkäufe

GET /sales

Zusammenfassung : Alle Verkäufe (historisch) abruft.

Antworten :

• 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}

Zusammenfassung : Ruft einen Verkauf nach seiner ID ab.

Parameter :

• Weg :
  • id (Ganzzahl): Die ID des Verkaufs zum Abrufen.

Antworten :

• 200 OK

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

• 404 nicht gefunden

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

---

POST /sales

Zusammenfassung : Erstellt einen neuen Verkauf.

Antragsbehörde :

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

Antworten :

• 201 erstellt

  {
    "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 schlechte Anfrage

  {
    "message" : " Validation error messages "
  }

---

DELETE /sales/{id}

Zusammenfassung : Löscht (abbrechen) einen Verkauf durch seine ID.

Parameter :

• Weg :
  • id (Ganzzahl): Die ID des Verkaufs zu löschen.

Antworten :

• 204 Kein Inhalt

• 400 schlechte Anfrage

  {
    "message" : " Error message "
  }

• 404 nicht gefunden

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