跳到正文
TakoAPI
返回技能列表

neo-api-to-ts-interface

由 martinforsulu 提供

Web & Frontend Development
—暂无评分
你的评分

简介

Automatically generates TypeScript interfaces from REST API responses with Storybook-style documentation UI.

描述

该技能的功能

Generates TypeScript interfaces from REST API responses by parsing JSON or XML payloads and inferring type structures. Produces formatted, compilable TypeScript code alongside Storybook-style documentation for exploring and sharing types. Supports CLI, programmatic, and agent workflow usage.

Removes the manual round-trip between fetching an API response and writing matching TypeScript, eliminating drift between actual response shapes and declared types.

何时使用

  • Converting a third-party API response into typed interfaces before writing client code
  • Batch-processing multiple endpoints to keep a shared types file in sync
  • Generating interactive type documentation for an internal API
  • Validating that existing TypeScript interfaces match current API response shapes
  • Automating interface generation in a CI pipeline after API schema changes

示例工作流

输入

User asks: Generate TypeScript interfaces from this API response: {"id":1,"user":{"name":"Alice","roles":["admin"]},"active":true}

智能体
  1. 1

    Parse the JSON payload and recursively traverse its structure

  2. 2

    Infer types for each field: primitives, nested objects, arrays, and unions

  3. 3

    Generate a formatted TypeScript interface file with readonly modifiers and proper union types

  4. 4

    Validate the output against the TypeScript compiler API

  5. 5

    Render a Storybook CSF documentation file with collapsible type explorer

输出

A compilable types.ts file with inferred interfaces and an accompanying Storybook HTML doc showing the type hierarchy with example values

安装

clawhub install martinforsulu/neo-api-to-ts-interface

运行 CLI 命令,或把这段提示词粘贴到 Claude Code、Cursor、Codex 或你在用的任意编程智能体里。

链接