Un’API è un accordo tra sistemi e tra persone. Quando il contratto è ambiguo, ogni modifica può introdurre dati mancanti, comportamenti inattesi o interventi manuali.
Definisci significato e formato
Per ogni campo importante, chiarisci cosa rappresenta, quando può essere assente e quale formato usa. La stessa parola può avere significati diversi in due applicazioni.
Versiona i cambiamenti
Un cambiamento incompatibile va annunciato, documentato e introdotto con una fase di transizione. La compatibilità non dovrebbe dipendere dalla fortuna.
Tratta gli errori come parte del contratto
Codici, messaggi e condizioni di retry devono essere previsti quanto la risposta positiva. È così che un’integrazione continua a funzionare anche quando qualcosa cambia.