Anteprima: non è ancora attivo nulla. La sandbox non è aperta: apre con la prima chiave di test. Fino ad allora, un mock generato dal contratto risponde a ogni operazione.
Sviluppa su un mock
Un server mock generato dal contratto, il documento OpenAPI da cui sono generate le pagine sotto Riferimento, risponde a ogni operazione prima che sia attiva. Con Prism:
Fissa una versione esatta 5.x di Prism (@stoplight/prism-cli@5.x.y). Con --dynamic, Prism genera le risposte dagli schemi del contratto invece di ripetere un solo esempio. Il file del contratto è distribution-v1.yaml; scrivi a support@gridbeds.com se non ce l’hai ancora. Dallo stesso documento si possono generare librerie client.
La sandbox
La sandbox è https://staging-api.gridbeds.com/api/v1/distribution, e si usa con una chiave gbd_test_ (Autenticazione). Apre con la prima chiave di test, rilasciata dal team di Gridbeds.
Quando è aperta, prism proxy controlla le risposte della sandbox rispetto al contratto mentre il tuo client ci parla:
Cosa provare
- Una prima lettura completa di ogni elenco, poi una seconda con
updated_since che riporta solo quello che è cambiato, come in Sincronizzazione.
- Un tombstone, sia
withdrawn sia deleted, su ogni risorsa, e un valore di enumerazione che il tuo codice non conosce.
- Un
410 per un updated_since più vecchio di 35 giorni, che deve far partire una risincronizzazione.
- Un avviso consegnato due volte, fuori ordine, con una versione più bassa di quella che hai, e con una firma sbagliata o un timestamp scaduto (Webhook).
- Un
429 con Retry-After (Errori e limiti).
