Per lavorare in modo sicuro e prevedibile, l'API deve monitorare rigorosamente i dati che vengono accettati e restituiti. EMC supporta JSON Schema, una descrizione formale della struttura dei dati che consente di convalidare automaticamente le richieste e le risposte sul lato server e client.
JSON Schema consente di identificare errori durante la fase di integrazione, eliminare comportamenti instabili, garantire la compatibilità tra sistemi e migliorare l'affidabilità dell'interazione con l'API.
Cosa dà JSON Schema
| Funzionalità | Cosa fornisce |
|---|---|
| Verifica struttura | Verificare che l'oggetto corrisponda ai campi e ai tipi previsti |
| Campi obbligatori | Controllo della disponibilità di attributi critici |
| Tipizzazione | Controllo chiaro di numeri, righe, bollo e array |
| Vincoli e formati | Supporto della lunghezza minima/massima, enum, pattern, formato email, ecc. |
| Riutilizzo | Creazione di modelli e componenti riutilizzati |
Come funziona la validazione
1. La richiesta o la risposta viene confrontata con uno schema predefinito
2. Se ci sono delle deviazioni, l'API restituisce un errore di spiegazione
3. È possibile combinare, ereditare, utilizzare regole condizionali
4. Applicabile a qualsiasi livello, query, corpo, intestazioni, parametri query
Vantaggi per API e client
Protezione da dati non corretti e dannosi
Maggiore stabilità dell'integrazione e prevedibilità dei comportamenti
Test e generazione automatica dei Mook basati su diagrammi
Possibilità di utilizzare gli schemi nella documentazione e nella Swagger/OpenAPI
Supporto e scalabilità semplificate delle API
Dove è particolarmente rilevante
Piattaforme con integrazione esterna e API per partner
Applicazioni mobili e frontend in attesa di una chiara struttura di risposta
CI/CD pipline con test API automatici
Sistemi con parametri e contratti dinamicamente modificabili
JSON Schema è una tecnologia fondamentale per il funzionamento rigoroso e affidabile dell'API. Rende i dati validi, le integrazioni sicure e lo sviluppo prevedibile.