Schnittstellenvertrag

Ein Schnittstellenvertrag ist die abgestimmte Beschreibung, wie Systeme Daten austauschen sollen. Dazu gehören erwartete Eingaben, Antworten, Fehler und die Bedeutung dieser Rückmeldungen. Eine maschinenlesbare Beschreibung kann Teile davon ausdrücken; fachliche Vereinbarungen müssen ebenfalls nachvollziehbar sein.

Die Bedeutung einer Antwort festhalten

Im fiktiven Kundenportal bestätigt eine erfolgreiche Übermittlung zunächst nur den Eingang bei einer Vermittlungskomponente. Ob das ERP den Auftrag angelegt hat, erfordert eine gesonderte Rückmeldung. Wenn der Sender die erste Antwort bereits als vollständige Erledigung deutet, passt seine Nutzung nicht zur Vereinbarung.

Beschreibung und Umsetzung abgleichen

OpenAPI definiert eine standardisierte Beschreibung für HTTP-APIs. Solche Beschreibungen helfen, verfügbare Operationen und Antworten verständlich zu machen. Sie beweisen allein jedoch nicht, dass eine laufende Anwendung den vereinbarten Ablauf erfüllt. Prüfen Sie passende Beispiele und Fehlerfälle gegen die Umsetzung. Bei Änderungen muss außerdem klar sein, welche beteiligten Systeme von welcher Vereinbarung ausgehen.

Quellen

• OpenAPI Initiative: OpenAPI Specification