Versionamento
Come cambia l’API e come glielo comunichiamo.
La versione è indicata nel percorso: /api/v1.
All’interno della v1 apportiamo solo modifiche che non compromettono un’integrazione corretta:
- nuovi endpoint;
- nuovi campi facoltativi nella richiesta;
- nuovi campi nella risposta;
- nuovi codici di errore e nuovi valori di
status.
Legga le risposte in modo tollerante: ignori i campi che non conosce.
Una modifica incompatibile riceve una nuova versione (/api/v2), annunciata in anticipo ai titolari degli account API.
La descrizione dell’API in formato leggibile dalle macchine si trova in /api/v1/openapi.json, per Postman o un generatore di client.