Toolverse
All skills

openapi-to-typescript

by davila7

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

Quick info

Author
davila7
Category
Backend
Views
3

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

  1. Przygotuj plik OpenAPI w formacie JSON lub YAML (musi być wersja 3.0.x). Plik powinien zawierać sekcje paths (endpointy) i components.schemas (definicje typów).

  2. Uruchom skill i podaj ścieżkę do pliku OpenAPI. Jeśli ścieżka nie zostanie podana, skill poprosi Cię o nią.

  3. Skill automatycznie waliduje plik – sprawdza, czy pole openapi zaczyna się od "3.0", czy istnieją sekcje paths i components.schemas. Jeśli walidacja się nie powiedzie, otrzymasz komunikat o błędzie.

  4. Skill ekstrahuje schematy z components.schemas i definicje żądań/odpowiedzi z paths, a następnie mapuje typy OpenAPI na TypeScript (string, number, boolean, obiekty, tablice itp.).

  5. 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.ts w bieżącym katalogu – możesz zmienić lokalizację.

  6. 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.

Related skills