Skip to main content
Die aktuelle öffentliche API-Version ist Bestandteil der Basis-URL:
Das OpenAPI-Dokument bezeichnet die JobHandy Public API als Version 1.0.0 und verwendet OpenAPI 3.1.0.
Die aktualisierten Order- und Division-Schemas werden innerhalb der API-Version 1.0.0 dokumentiert. Die produktive Basis-URL bleibt https://api.jobhandy.io/v1; ein /v2-Endpoint oder eine separate Spezifikationsrevision wird nicht eingeführt.

Änderungsklassifizierung

Regeln für Client-Design

  • Verwenden Sie keine strikte Response-Deserialisierung, die unbekannte Eigenschaften ablehnt.
  • Gehen Sie nicht davon aus, dass eine Enum-Liste niemals erweitert wird.
  • Senden Sie ausschließlich dokumentierte Request-Eigenschaften, da Request-Schemas geschlossen sind.
  • Pinnen und archivieren Sie die OpenAPI-Datei, mit der der Client erzeugt oder validiert wurde.
  • Vergleichen Sie jeden neuen Vertrag vor dem Deployment mit der gepinnten Version.
  • Prüfen Sie den Changelog auf Migrationshinweise.

Ablauf eines Vertragsupdates

Deprecation

Eine zukünftige Deprecation muss vor der Entfernung über den öffentlichen Changelog und eine Migrationsanleitung kommuniziert werden. Verlassen Sie sich nicht auf einen undokumentierten Endpoint oder ein undokumentiertes Feld, nur weil es in einer internen Umgebung sichtbar ist.
Zuletzt geändert am 28. August 2026