Zum Hauptinhalt springen

Hands-On: Open-API

Aufgabe: OpenAPI-Spezifikation für eine einfache Produkt-API erstellen​

Erstelle eine OpenAPI-Spezifikation für eine API, die grundlegende Informationen über Produkte bereitstellt. Die API soll folgende Funktionen unterstützen:

  1. Alle Produkte auflisten
    Endpunkt: GET /produkte
    Antwort: Eine Liste von Produkten (jedes Produkt hat eine ID, einen Namen und einen Preis).

  2. Einzelnes Produkt abrufen
    Endpunkt: GET /produkte/{id}
    Parameter: id (Pfadparameter, die ID des Produkts)
    Antwort: Die Informationen des gewünschten Produkts (ID, Name, Preis).

  3. Neues Produkt hinzufügen
    Endpunkt: POST /produkte
    Anfrage: Ein JSON-Objekt, das die Daten des neuen Produkts enthält (Name, Preis)
    Antwort: Die ID des neu erstellten Produkts.

  4. Produkt löschen
    Endpunkt: DELETE /produkte/{id}
    Parameter: id (Pfadparameter, die ID des Produkts)
    Antwort: Bestätigung, dass das Produkt gelöscht wurde.

Anforderungen​

  1. Definiere eine Product-Schema-Komponente mit den Eigenschaften id, name, und price.
  2. Implementiere für jeden Endpunkt die Antwort-Codes (200, 201 oder 404 für nicht gefunden bei ungültiger ID).
  3. Verwende YAML als Format für deine Spezifikation.

Hinweise​

Nutze den components/schemas Abschnitt, um das Product Schema zu definieren, und verwende $ref, um das Schema bei den entsprechenden Endpunkten zu referenzieren.