Skip to content
dsh.fish
Bundle

dsh-json-types

JSON 类型生成:把 JSON 数据转换为 TypeScript 接口 / JSON Schema / Python(Pydantic) 模型,自动推断字段类型、嵌套对象与数组元素类型

Source
uckkk
License
MIT
Updated
Updated 3 days ago

Readme

# dsh-json-types · JSON 类型生成

把一段 JSON 数据一键转换为 **TypeScript 接口 / JSON Schema / Python(Pydantic) 模型**,自动推断字段类型、嵌套对象、数组元素类型、可选字段。纯 Node 实现,无网络、无外部服务。

## 提供的工具

| 工具 | 作用 |
|---|---|
| `json_to_ts` | JSON → TypeScript 接口 |
| `json_to_schema` | JSON → JSON Schema(draft-07) |
| `json_to_python` | JSON → Python Pydantic 模型 |

## 安装

```bash
dsh plugin add dsh-json-types
```

安装后在 profile 的 `package.json` 的 `dsh.profile.bundles` 中加入 `"dsh-json-types"`。

## 用法示例

```
把这个接口响应转成 TypeScript 类型
→ 调用 json_to_ts(data=<JSON>)

转成 JSON Schema 做校验
→ 调用 json_to_schema(data=<JSON>)

转成 Python 模型
→ 调用 json_to_python(data=<JSON>)
```

## 说明

- 嵌套对象生成命名接口/模型,数组元素为对象时合并各元素字段、缺失字段标记为可选(`?`/`Optional`)。
- 类型推断基于样本数据(字符串可能实为枚举/日期等),复杂场景可生成后人工微调。

## 安装

```bash
dsh plugin add github:uckkk/dsh-json-types
```

> 安装即在本机运行第三方代码,请自行审阅源码。

## 安装

```bash
dsh plugin add github:uckkk/dsh-json-types
```

## 使用

安装后在会话中调用该插件注册的工具即可。

## 许可

MIT

> 安装即在本机运行第三方代码,请自行审阅源码。

Install

dsh plugin --profile web add github:uckkk/dsh-json-types#21068e66714d7df2f24b3a80eab402f6aae7f49a

Profile: web

Source