Creați o interfață TypeScript din JSON

Echipele API folosesc JSON în TypeScript pentru a crea o interfață dintr-un răspuns exemplu și a o adapta proiectului.

Creați o interfață TypeScript din JSON, apoi adaptați structura generată la proiectul vostru. Folosiți-l în browser fără să creați un cont.

Cum se folosește

  1. Lipiți un exemplu JSON în zona de introducere sau importați un fișier compatibil.
  2. Faceți clic pe Generați pentru a produce o interfață TypeScript.
  3. Rezultatul afișează tipurile deduse din proprietățile din exemplul dvs.
  4. Examinați câmpurile, tipurile și opțiunile posibile, apoi copiați codul.
  5. Folosiți Ștergeți pentru a goli câmpurile și a testa un alt exemplu.

Exemplu

Primiți un răspuns API și doriți să tipizați rapid conținutul acestuia. Lipiți un exemplu JSON, generați interfața TypeScript, apoi integrați-o în proiectul dvs. Economisiți timp la declarațiile de tip de bază.

Limite și formate

Unde are loc procesarea

Totul se întâmplă în browserul dvs.: analiza și generarea sunt locale, fără a trimite date afară. Puteți astfel lucra cu fragmente de răspunsuri reale păstrând confidențialitatea.

Întrebări frecvente

Câmpurile opționale sunt marcate în interfața generată?

Instrumentul se bazează pe un singur exemplu. Dacă un câmp este prezent, este considerat obligatoriu. Câmpurile care lipsesc din exemplul dvs. nu pot fi ghicite ca opționale. Va trebui să le ajustați manual.

Pot genera interfețe pentru tablouri de obiecte?

Da, dacă exemplul dvs. conține un tablou de obiecte, instrumentul deduce tipul elementului și îl reflectă în interfață. Verificați dacă tipul generat corespunde structurii fiecărui element.

Codul produs poate fi compilat direct?

Interfața TypeScript generată este corectă sintactic în majoritatea cazurilor, dar poate conține tipuri prea largi sau nume de adaptat. Examinați-o și corectați-o înainte de a o integra în proiectul dvs.

Cum sunt deduse tipurile în interfața generată?

Tipurile sunt deduse din proprietățile eșantionului JSON introdus. Instrumentul analizează exemplul și produce o interfață TypeScript. Totuși, inferența se bazează pe un singur exemplu, așa că tipurile complexe precum uniunile sau literalii nu sunt ghicite, iar câmpurile opționale nu sunt detectate. Numele de tipuri pot fi generice și pot necesita redenumire. Analiza și generarea sunt locale, în browser, fără trimiterea datelor.

Pot schimba numele interfeței generate?

Da, probabil trebuie. Numele de tipuri pot fi generice și pot necesita redenumire. Instrumentul produce o interfață TypeScript pe baza eșantionului, dar nu compilează codul; oferă doar o propunere. Verifică câmpurile, tipurile și opțiunile, apoi adaptează numele înainte de integrare. Analiza și generarea sunt locale, în browser, fără trimiterea datelor.

Instrumente din aceeași categorie