Hoppa till innehåll

OpenAPI till TypeScript

Generera TypeScript-typer från scheman i ett OpenAPI 3- eller Swagger 2.0-dokument i YAML eller JSON. Varje post under components.schemas, eller definitioner i Swagger 2.0, blir ett exporterat gränssnitt eller typalias. $ref-länkar mellan dem blir typenamn och nullbara fält får | null.

Återställ

Vanliga frågor

Vilka delar av dokumentet konverteras?

Scheman under components.schemas i OpenAPI 3 och under definitions i Swagger 2.0. Paths, parametrar och svar omvandlas inte till typer; referera till de genererade schematyperna i din egen kod för begäranden och svar.

Hur omvandlas schemanamn till typenamn?

Varje schemanyckel byggs om i PascalCase, så user-profile blir UserProfile. När två nycklar skulle ge samma namn får den andra ett nummer tillagt.

Stöds nullbara fält?

Ja. nullable: true från OpenAPI 3.0 och x-nullable: true från Swagger 2.0 lägger till | null, och OpenAPI 3.1-typmatriser som ["string", "null"] blir string | null.

Vad händer med referenser som verktyget inte kan lösa?

En $ref som pekar utanför dokumentet eller på något annat än ett schema i components.schemas eller definitions blir unknown och listas i en kommentar överst i resultatet.

Stöds YAML?

Ja. Klistra in dokumentet som YAML eller JSON. Ankare och alias i YAML expanderas före konverteringen.

Hur kontrollerar jag dokumentet först?

Använd OpenAPI-validatorn, som listar strukturella problem och brutna referenser. Den här konverteraren läser endast scheman och rapporterar inga andra fel.

Om OneClick Pro

OneClick Pro är en kostnadsfri samling med mer än 150 webbverktyg för det dagliga arbetet: konvertera bilder och enheter, formatera och validera kod, kontrollera domäner och SEO samt arbeta med text, datum och tal. Alla verktyg fungerar utan registrering eller prenumeration, och det du anger används bara för att beräkna resultatet och sparas aldrig. Använd samlingen som en snabb verktygslåda för enstaka uppgifter eller bokmärk verktygen du använder varje dag.