Skip to content

StudiTaxi/carapi

Repository files navigation

CarAPI

Die Car-API ist eine REST-API zum laden von Fahrzeugdaten. Sie wird NICHT mehr für den Betrieb von StudiTaxi benötigt.

Endpunkte

Folgende Endpunkte stehen zur Verfügung:

  • GET /makes/: Laden aller Hersteller
  • GET /makes/{makeId}: Laden eines spezifischen Herstellers
  • GET /makes/{makeId}/models: Laden aller Fahrzeuge eines Herstellers
  • GET /makes/{makeId}/models/{modelId}: Laden eines spezifischen Fahrzeugs
  • GET /makes/{makeId}/models-stripped/: Performantere Version für GET /makes/{makeId}/models. Enthält nur die wichtigsten Attribute für die Traversierung des Pfades, um Payload einzusparen.

Voraussetzungen

Diese API basiert auf Spring Boot. Daher ist eine Installation von Java (21+) erforderlich. Zusätzlich wird eine kompatible Maven-Installation benötigt, um das Projekt zu bauen und Abhängigkeiten herunterzuladen.

Ausführung

Die Anwendung kann durch Ausführen des folgenden Befehls aus dem Stammverzeichnis des Projekts gestartet werden: ./mvnw spring-boot:run Standardmäßig speichert die Anwendung Daten in einer In-Memory H2-Datenbank. Die zu verwendende Datenbank kann in der Datei application.properties angegeben werden.

Dokumentation

Nach dem Start steht die Endpunktdokumentation unter http(s)://<server>:<port>/swagger-ui/index.html zur Verfügung.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •