development

ADR › RouteAPI Response Scheme

status	accepted
date	2023-05-16
deciders	Leonard Pelzer
consulted	Lining Bao
informed

Kontext und Problemstellung

Für die Response der Route-API muss ein Schema definiert werden, welches die Datenstruktur der Response beschreibt. In dieses Schema müssen die Routen-Daten der Here Transit-API und evtl. Probleme/Herausforderungen (welche die Disturbance-API liefert) integriert werden.

Entscheidungstreiber

• Alle Informationen müssen in einem Schema zusammengefasst werden.
• Das Schema muss erweitert werden können

In Betracht gezogene Optionen

• Eigenes Schema aufbauen
• Das bestehende Schema der Here Transit-API verwenden und erweitern

Ergebnis der Entscheidung

Gewählte Option: “Das bestehende Schema der Here Transit-API verwenden und erweitern”, weil dieses Schema eine bereits sehr gute Struktur aufweist und eine Vielzahl an Daten in einem Schema zusammenfasst. Die Here-Transit-API unterteilt eine Route in feste Abschnitte (Sections). Zu diesen Sections sind nun alle weiteren wichtigen Informationen zugeordnet.

Consequences

• 🟢 Gut, weil das Schema nicht aufwendig neu definiert werden muss.
• 🟢 Gut, weil das Schema beliebig erweitert werden kann.

Weitere Informationen

• Eine Darstellung des Schemas der Here-Transit-API befindet sich hier.

This site is open source. Improve this page.