astahmer/openapi-zod-client
Openapi Zod Client
Acest proiect este un instrument de linie de comandă care automatizează crearea de clienți HTTP TypeScript type-safe direct din specificațiile OpenAPI. Prin transformarea definițiilor de serviciu în cod sursă structurat, asigură sincronizarea tipurilor end-to-end și impune integritatea datelor la runtime peste limitele rețelei.
Generatorul se distinge prin maparea structurilor de date OpenAPI către scheme de validare Zod, permițând maparea consistentă a tipurilor bazată pe schemă și validarea răspunsurilor. Suportă sinteza sursei deduplicate pentru a minimiza redundanța în output-ul generat și oferă opțiuni de personalizare a șabloanelor, permițând utilizatorilor să modifice structura și formatarea codului rezultat prin reguli de randare definite.
Instrumentul gestionează întregul ciclu de viață al creării clientului, de la parsarea specificațiilor API eterogene într-un model intern unificat până la randarea handler-elor de cereri executabile. Este conceput pentru a se integra în fluxurile de lucru de dezvoltare prin producerea de module gata de utilizare care mențin contracte de date stricte între servicii.
Features
- OpenAPI Client SDK Generators - Automates the creation of type-safe TypeScript HTTP clients directly from OpenAPI specifications.
- End-to-End - Synchronizes API contracts with frontend code to prevent runtime errors by enforcing strict data types across the communication stack.
- Type-Safe Client Generators - Generates type-safe TypeScript HTTP clients from OpenAPI specifications to ensure consistent data structures across network boundaries.
- Schema Generators from OpenAPI - Generates Zod validation schemas for request parameters, bodies, and responses from OpenAPI specifications.
- Zod Schema Type Inferences - Translates OpenAPI data structures into Zod validation schemas to enforce runtime data integrity.
- API Code Generators - Provides a command-line interface that automates the creation of structured network request handlers and response validation logic.
- API-Driven Development Workflows - Streamlines backend service integration by automating the transformation of specifications into ready-to-use source code.
- Compile-Time Code Generation - Transforms static API specification files into executable TypeScript source code during the build process.
- Zod Response Validators - Validates API response bodies against generated Zod schemas at runtime to catch data shape mismatches.
- OpenAPI to TypeScript Converters - Transforms OpenAPI specifications into type-safe HTTP clients and Zod validation schemas for consistent network communication.
