sync-interface

Generate TypeScript typings from the core-interface OpenAPI specification.

Updated Dec 11, 2025
One-click install
npx skills add https://github.com/semicolon-devteam/semo --skill sync-interface
Or copy as Structured Prompt for Agentβ–Ό
Please help me install this Agent Skill.
Skill: sync-interface
Source: https://github.com/semicolon-devteam/semo/tree/main/packages/biz/poc/skills/sync-interface
Command: npx skills add https://github.com/semicolon-devteam/semo --skill sync-interface

SYSTEM DOCUMENTATION & REQUIREMENTS

πŸ’‘ This Skill includes references (resource) components.

What problem does it solve?

core-interface의 OpenAPI μŠ€νŽ™μ„ λ‹€μš΄λ‘œλ“œν•˜κ³  TypeScript νƒ€μž…μœΌλ‘œ λ³€ν™˜ν•΄ μΌκ΄€λœ API 계약을 μ œκ³΅ν•©λ‹ˆλ‹€.

Core Features & Use Cases

  • μŠ€νŽ™ λ‹€μš΄λ‘œλ“œ: μ΅œμ‹  릴리슀의 OpenAPI μŠ€νŽ™ μΆ”μΆœ
  • νƒ€μž… 생성: OpenAPI μŠ€νŽ™μœΌλ‘œ TS νƒ€μž… 생성
  • 정리 및 배포: μƒμ„±λœ νƒ€μž… μ €μž₯ μœ„μΉ˜μ™€ μ‚¬μš© 방법 μ•ˆλ‚΄

Quick Start

λ¦΄λ¦¬μŠ€μ—μ„œ μŠ€νŽ™ 파일(core.backend.spec.json)을 λ‹€μš΄λ‘œλ“œν•˜κ³  νƒ€μž… 파일(core-interface.ts)을 μƒμ„±ν•©λ‹ˆλ‹€.

Frequently Asked Questions about sync-interface

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync an OpenAPI spec to TypeScript types automatically?β–Ό

Sync OpenAPI specifications to TypeScript types by retrieving the latest core-interface release, downloading the core.backend.spec.json asset, and generating type definitions using openapi-typescript. The Skill automates this workflow to produce consistent, up-to-date TypeScript definitions at src/types/core-interface.ts for reliable API contracts.

Can I generate TypeScript types directly from an OpenAPI specification?β–Ό

Yes. OpenAPI specifications can be converted to TypeScript types automatically, eliminating manual type definitions and keeping types synchronized with API changes. This approach ensures your TypeScript interfaces always match the actual API contract defined in the OpenAPI spec.

What's the best way to keep TypeScript types in sync with API releases?β–Ό

Automate type synchronization by detecting the latest release, extracting the OpenAPI specification asset, and regenerating TypeScript definitions as part of your CI pipeline. This ensures types update automatically whenever the API interface changes, reducing manual maintenance and type mismatches.

How do I automate OpenAPI spec downloads and type generation in CI?β–Ό

Set up CI-driven synchronization to fetch the latest OpenAPI spec from releases, run openapi-typescript to generate type definitions, and integrate results into your project structure automatically. This approach enables hands-off type maintenance across deployments and release cycles.

Do I need to manually maintain TypeScript types when the API spec changes?β–Ό

No. By syncing OpenAPI specifications to TypeScript types automatically, manual type maintenance becomes unnecessary. Changes to the core-interface spec are detected, processed, and reflected in your TypeScript definitions without requiring manual intervention or updates.

What happens when a new core-interface release is published?β–Ό

The Skill detects the latest release, retrieves the OpenAPI specification asset, generates updated TypeScript types via openapi-typescript, and integrates them into src/types/core-interface.ts. This ensures your application always uses type definitions matching the current API contract.