Phoenix API Contracts

Dieses Repository enthält Dateien, die die Vereinbarung zur Rück- und Übergabe von Daten von und an Phoenix APIs beschreiben.

Einfach ausgedrückt, handelt es sich um Typescript Typen, die die JSON-Struktur beschreiben, die ein Phoenix API zurückgibt oder erwartet.

Die Dateien können als Abhängigkeiten in die Projekte eingebunden werden und als Typdeklaration für Variablen und Funktionen verwendet werden. Ein zentrales Repo vereinfacht es, Eigenschaften oder ganze Strukturen anzupassen und die Änderungen via NPM, durch einfaches Updaten der Pakete, in alle Projekte zu verteilen. Obsolete Typen können zudem global als deprecated markiert werden.

Insbesondere das Datenmodel von Mein Phoenix ist hier einigermaßen komplett beschrieben.

Die einfache Installation über npm genügt. Es ist kein Kompilieren oder ähnliches notwendig. Danach können die Typen in den Projekten referenziert werden.

Installation

npm i --save-dev @phoenix/api-contracts

Verwendung

import type { BookingModel, Reiseteilnehmer } from '@phoenix/api-contracts';