Contratto d’interfaccia

Un contratto d’interfaccia è la descrizione concordata di come i sistemi devono scambiare dati. Comprende input attesi, risposte, errori e significato di tali riscontri. Una descrizione leggibile dalla macchina può esprimerne alcune parti; anche gli accordi aziendali devono essere comprensibili.

Registrare il significato di una risposta

In un portale clienti fittizio, una trasmissione riuscita conferma inizialmente solo la ricezione da parte di un componente intermediario. Per sapere se l’ERP ha creato l’ordine serve un riscontro separato. Se il mittente interpreta la prima risposta come completamento totale, l’uso non corrisponde all’accordo.

Confrontare descrizione e implementazione

OpenAPI definisce una descrizione standardizzata per le API HTTP. Descrizioni di questo tipo aiutano a comprendere operazioni e risposte disponibili. Non provano da sole che l’applicazione in esecuzione rispetti il flusso concordato. Confronti esempi adeguati e casi d’errore con l’implementazione. Nei cambiamenti deve inoltre risultare chiaro quali sistemi partecipanti si basano su quale accordo.

Fonti

• OpenAPI Initiative: OpenAPI Specification