openapi-type-safe-sync

Community

Lock frontend types to backend OpenAPI.

AuthorSaintFore
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Maintains and synchronizes endpoint contracts between backend OpenAPI specs and frontend type systems, enabling automatic generation of openapi.json updates, TypeScript types, and a React Query-based request layer while aligning Zod and Pydantic validation.

Core Features & Use Cases

  • Generate TypeScript types from openapi.json using openapi-typescript.
  • Wrap openapi-fetch with React Query's useQuery and useMutation hooks.
  • Normalize and unify API errors via a Zod-based parsing layer compatible with backend schemas.
  • Ensure no manual frontend interface typing; all types derived from OpenAPI schemas and backend changes.

Quick Start

Install the toolchain and run the OpenAPI-driven sync workflow to regenerate types and client hooks from openapi.json.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: openapi-type-safe-sync
Download link: https://github.com/SaintFore/OpenCodeSettings/archive/main.zip#openapi-type-safe-sync

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.