openapi-to-typescript
Converts OpenAPI 3.0 JSON/YAML to TypeScript interfaces and type guards. This skill should be used when the user asks to generate types from OpenAPI, convert schema to TS, create API interfaces, or generate TypeScript types from an API specification.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Converts OpenAPI 3.0 JSON/YAML to TypeScript interfaces and type guards. This skill should be used when the user asks to generate types from OpenAPI, convert schema to TS, create API interfaces, or generate TypeScript types from an API specification.
How to use
Przygotuj plik OpenAPI w formacie JSON lub YAML (musi być wersja 3.0.x). Plik powinien zawierać sekcje
paths(endpointy) icomponents.schemas(definicje typów).Uruchom skill i podaj ścieżkę do pliku OpenAPI. Jeśli ścieżka nie zostanie podana, skill poprosi Cię o nią.
Skill automatycznie waliduje plik – sprawdza, czy pole
openapizaczyna się od "3.0", czy istnieją sekcjepathsicomponents.schemas. Jeśli walidacja się nie powiedzie, otrzymasz komunikat o błędzie.Skill ekstrahuje schematy z
components.schemasi definicje żądań/odpowiedzi zpaths, a następnie mapuje typy OpenAPI na TypeScript (string, number, boolean, obiekty, tablice itp.).Wygenerowany plik TypeScript zawiera interfejsy dla każdego schematu oraz type guardy do walidacji danych w runtime. Domyślnie plik zapisywany jest jako
types/api.tsw bieżącym katalogu – możesz zmienić lokalizację.Otrzymujesz gotowy plik TypeScript, który możesz od razu zaimportować w swoim projekcie i używać do typowania requestów i responsów z API.