json naar typoscript

De JSON naar TypeScript converter leest een voorbeeld JSON waarde - een API antwoord, een config bestand, een database record - en schrijft de TypeScript interfaces die het beschrijven Geneste objecten worden hun eigen benoemde interfaces, arrays van objecten worden samengevoegd tot een enkele element interface in plaats van een uitgestrekte unie, en sleutels die nul zijn of ontbreken in sommige records zijn gemarkeerd als optioneel U plakt gegevens die u al hebt; u krijgt types die u anders met de hand zou schrijven.

Het met de hand typen van een API-reactie is vervelend en foutgevoelig op een specifieke manier: u typt wat u *denkt* het eindpunt keert terug, niet wat het daadwerkelijk heeft geretourneerd. Velden die je nooit hebt opgemerkt, worden weggelaten, een geheel getal dat soms null wordt, wordt getypt als `getal` en de fout verschijnt tijdens runtime in productie in plaats van in je editor. Door typen rechtstreeks uit een echte payload te genereren, wordt die kloof dicht, omdat de vorm waartegen u compileert de vorm is die de server daadwerkelijk heeft verzonden.

Alles draait in uw browser De gevolgtrekkingsengine is afhankelijkheidsvrij TypeScript, geen wrapper rond een externe service, dus payloads - die routinematig toegangstokens, klantrecords en interne ID's bevatten - verlaten nooit de pagina Kies interfaces of typ aliassen, schakel het trefwoord ` en `readonly` modifiers in, kies uw inspringbreedte en kopieer vervolgens de uitvoer of download een .ts-bestand.

De gegenereerde interfaces beschrijven het monster dat u hebt opgegeven, niet de API die u aanroept, en dat onderscheid is het hele risico Een veld dat toevallig aanwezig is in elk object van uw monster is gemarkeerd vereist, zelfs als de server het soms weglaat, en een veld dat nul is in het monster kan niet worden onderscheiden van een veld dat altijd nul is Lege arrays zijn het duidelijkste geval: een array zonder elementen geeft geen informatie over wat het bevat De samensmelting van de array helpt hier door elk object in een lijst te combineren in één interface en sleutels te markeren die ontbreken in sommige vermeldingen als optioneel, dus een groter en gevarieerder voorbeeld levert een eerlijker type op Waar de API een schema of OpenAPI-document heeft, genereer daaruit in plaats daarvan en gebruik dit voor het verkennen van een ongedocument.