Ein Datensatz kann eine Kennung liefern, die bei einem späteren Aufruf gebraucht wird. Das Link Object in OpenAPI beschreibt diese Beziehung im API-Vertrag. Der Folgeschritt bleibt von den tatsächlichen Eingaben, den Berechtigungen und der Entscheidung des Clients abhängig.
Die Beziehung am eigenen Beispiel formulieren
Ein Katalogdienst liefert eine Antwort mit Titel und Kennung eines Buchs. Ein anderer Aufruf liefert die Ausgaben zu dieser Kennung. In der API-Beschreibung kannst du an der ersten Antwort festhalten, welcher weitere Aufruf dazu passt und woher sein Parameter stammt. OpenAPI 3.1.2 beschreibt diesen Zusammenhang als Link, der bereits im Vertrag festgelegt wird. Ein Client findet den vorgesehenen Weg in der Dokumentation. Die Laufzeitantwort braucht dafür laut Spezifikation keinen eingebetteten Hyperlink.
Den Parameter bis zur Quelle verfolgen
Die Spezifikation sieht eine Referenz oder eine Operationskennung für das Ziel vor. Werte für Parameter können aus einem Ausdruck entstehen, der auf Anfrage oder Antwort zugreift. Für das Buchbeispiel hältst du fest, welches Feld die Buchkennung trägt und an welcher Stelle der Folgeaufruf sie erwartet. Prüfe dabei den Namen, den Datentyp und den Fall einer fehlenden Angabe. Wenn der Ausdruck keinen passenden Wert liefert, ist das eine offene Eingabe für den nächsten Schritt. Eine automatisch geratene Ersatzkennung könnte auf einen falschen Datensatz zeigen.
Die Erlaubnis getrennt beurteilen
Die OpenAPI-Dokumentation stellt klar, dass die bloße Beziehung keinen erfolgreichen Aufruf garantiert. Eine API kann zum Beispiel die Buchdaten öffentlich liefern, aber bestimmte Zusatzinformationen nur für berechtigte Konten bereitstellen. Der Client sollte deshalb weder aus der Kennung noch aus der dokumentierten Beziehung ein Zugriffsrecht ableiten. Dokumentiere die Anforderungen am Zielaufruf und beschreibe, welche Rückmeldung bei fehlendem Zugriff sinnvoll ist. So bleiben Datenbeziehung und Autorisierung in der Implementierung verständlich.
Den Vertrag mit zwei passenden Fällen lesen
Nutze in einer Testumgebung eine Antwort mit bekannter Kennung und eine mit fehlender Zuordnung. Prüfe zuerst, ob der Parameter wie beschrieben gelesen wird. Prüfe anschließend separat, wie der Client mit einem verweigerten oder unvollständigen Folgeaufruf umgeht. Solche Prüfungen zeigen, ob Dokumentation, Client und Backend denselben Ablauf erwarten. Das Beispiel ordnet einen bestehenden Spezifikationsabschnitt ein. Es belegt keinen Zugriff auf einen externen Katalog.
Quellen & Aktualität
Quellen geprüft am 2026-11-07. Herstellerangaben sind als solche eingeordnet. Produktdetails können sich nach diesem Stand ändern.

