首页
/ QuickType 使用教程

QuickType 使用教程

2024-09-25 14:54:25作者:袁立春Spencer

1. 项目介绍

QuickType 是一个开源项目,旨在帮助开发者从 JSON、JSON Schema、TypeScript 和 GraphQL 查询中生成强类型的模型和序列化器。通过 QuickType,开发者可以轻松地在多种编程语言中安全地处理 JSON 数据。QuickType 支持多种目标语言,包括 Ruby、JavaScript、Flow、Rust、Kotlin、Dart、Python、C#、Go、C++、Java、Scala、TypeScript、Swift、Objective-C、Elm、JSON Schema、Pike、Prop-Types、Haskell 和 PHP。

2. 项目快速启动

安装 QuickType

QuickType 可以通过 npm 全局安装:

npm install -g quicktype

使用 QuickType

以下是一些基本的使用示例:

生成 C# 代码

echo '[ "name": "David" ]' | quicktype -l csharp

生成 Go 代码

echo '[1, 2, 3]' | quicktype -o ints.go

生成 Swift 代码

quicktype person.json -o Person.swift

生成 Java 代码

quicktype https://api.somewhere.com/data -o Data.java

3. 应用案例和最佳实践

从 JSON 生成 JSON Schema

推荐的工作流程是从样本数据生成 JSON Schema,审查和编辑 Schema,并将其提交到项目仓库中。然后,在构建过程中从 Schema 生成模型代码。

# 首先,从样本推断 JSON Schema
quicktype pokedex.json -l schema -o schema.json

# 审查 Schema,进行更改,并提交到项目仓库

# 最后,在构建过程中生成模型代码
quicktype -s schema schema.json -o src/ios/models.swift
quicktype -s schema schema.json -o src/android/Models.java
quicktype -s schema schema.json -o src/nodejs/Models.ts

从 TypeScript 生成代码(实验性)

你也可以通过编写或生成 TypeScript 文件,然后使用 QuickType 生成代码。

# 首先,从样本推断 TypeScript 文件(或直接编写一个)
quicktype pokedex.json -o pokedex.ts --just-types

# 审查 TypeScript,进行更改,等等

# 生成 Swift 代码
quicktype pokedex.ts -o src/ios/models.swift

4. 典型生态项目

QuickType 作为一个强大的工具,可以与许多其他开源项目结合使用,以增强开发流程。以下是一些典型的生态项目:

  • TypeScript: 用于定义类型和生成强类型代码。
  • JSON Schema: 用于定义 JSON 数据的结构,并生成相应的代码。
  • GraphQL: 用于查询数据,并生成相应的模型和序列化器。
  • npm: 用于安装和管理 QuickType 及其依赖项。

通过结合这些工具,开发者可以更高效地处理和生成代码,从而提升开发效率和代码质量。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512