当前位置：首页 > 科技 > 软件

受 TypeScript 启发，微软又搞了一个神器！

来源：责编：时间：2024-04-07 17:06:23 131观看

导读TypeSpec 是什么TypeSpec[1] 是一种高度可扩展的语言，可轻松描述 REST、OpenAPI、gRPC 和其他协议中常见的 API 结构。TypeSpec 在生成多种不同的 API 描述格式、客户端和服务端代码、文档等方面表现出色。有了 TypeSp

TypeSpec 是什么

TypeSpec[1] 是一种高度可扩展的语言，可轻松描述 REST、OpenAPI、gRPC 和其他协议中常见的 API 结构。TypeSpec 在生成多种不同的 API 描述格式、客户端和服务端代码、文档等方面表现出色。有了 TypeSpec，你就可以摆脱那些拖慢你速度的手写文件，并在几秒钟内生成符合标准的 API Schemas。

TypeSpec 的特点

简洁轻量：受 TypeScript 的启发，TypeSpec 是一种极简语言，可帮助开发人员以熟悉的方式描述 API。
易集成：编写 TypeSpec，发布为各种格式，快速与其它生态系统集成。
支持多种协议：TypeSpec 标准库支持主流的 OpenAPI 3.0，JSON Schema 2020-12，Protobuf，和 JSON RPC 等协议。
功能强大：受益于庞大的 OpenAPI 工具生态系统，可用于配置 API 网关、生成代码和验证数据。
保证数据一致性：定义要在 API 中使用的通用模型，使用 JSON Schema 发射器获取类型的 JSON Schema，并使用它们验证数据。
友好的开发体验：在 VSCode 和 Visual Studio 编辑器中为了 TypeSpec 提供了全面的语言支持。比如，语法高亮、代码补全等功能。

TypeSpec 使用示例

生成 OpenAPI 描述文件

图片

生成 JSON Schema

图片

生成 Protobuf

图片

TypeSpec Playground

要快速体验 TypeSpec 的功能，推荐你使用 TypeSpec 官方提供的 playground[2]。该 playground 预设了 API versioning、Discriminated unions、HTTP service、REST framework、Protobuf Kiosk 和 Json Schema 6 个不同的使用示例，并支持 File 和 Swagger UI 两种视图。

File 视图

图片

Swagger UI 视图

图片

TypeSpec 快速上手

1.安装 @typespec/compiler 编译器

npm install -g @typespec/compiler

2.安装 VSCode 扩展

在 VSCode 中搜索 TypeSpec 安装 TypeSpec for VS Code 扩展，或在浏览器中打开 TypeSpec for VS Code[3] 网址后点击 Install 按钮。

3.创建 TypeSpec 项目

首先新建一个新的目录，然后在项目的根目录下执行以下命令：

tsp init

图片

4.安装项目依赖

tsp install

成功执行上述命令后，在当前目录下会生成以下目录结构：

.├── main.tsp├── node_modules├── package-lock.json├── package.json└── tspconfig.yaml

之后，打开 main.tsp 文件，输入以下代码：

import "@typespec/http";using TypeSpec.Http;@service({  title: "Widget Service",})namespace DemoService;model Widget {  @visibility("read", "update")  @path  id: string;  weight: int32;  color: "red" | "blue";}@errormodel Error {  code: int32;  message: string;}@route("/widgets")@tag("Widgets")interface Widgets {  @get list(): Widget[] | Error;  @get read(@path id: string): Widget | Error;  @post create(...Widget): Widget | Error;  @patch update(...Widget): Widget | Error;  @delete delete(@path id: string): void | Error;  @route("{id}/analyze") @post analyze(@path id: string): string | Error;}

完成输入后，运行 tsp compile . 命令执行编译操作。成功编译后，在 tsp-output/@typespec/openapi3 目录下就会生成 openapi.yaml 文件：

图片

有关 TypeSpec 的相关内容就介绍到这里，如果你想进一步了解 TypeSpec 的基础使用和高级用法，推荐你阅读官方的使用文档[4]。

参考资料

[1]TypeSpec: https://typespec.io/

[2]playground: https://typespec.io/playground

[3]TypeSpec for VS Code: https://marketplace.visualstudio.com/items?itemName=typespec.typespec-vscode

[4]使用文档: https://typespec.io/docs

本文链接：http://www.28at.com/showinfo-26-81739-0.html受 TypeScript 启发，微软又搞了一个神器！

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。邮件：2376512515@qq.com

上一篇： SpringSecurity保护了什么？你知道吗？

下一篇：重磅榜单：去年赚钱的编程语言前十名

标签：

热门焦点

Automa-通过连接块来自动化你的浏览器

1、前言通过浏览器插件可实现自动化脚本的录制与编写，具有代表性的工具就是：Selenium IDE、Katalon Recorder，对于简单的业务来说可快速实现自动化的上手工作。Selenium IDEKat
一年经验在二线城市面试后端的经验分享

忠告这篇文章只适合2年内工作经验、甚至没有工作经验的朋友阅读。如果你是2年以上工作经验，请果断划走，对你没啥帮助~主人公这篇文章内容来自「升职加薪」星球星友的投稿，坐
之家push系统迭代之路

前言在这个信息爆炸的互联网时代，能够及时准确获取信息是当今社会要解决的关键问题之一。随着之家用户体量和内容规模的不断增大，传统的靠"主动拉"获取信息的方式已不能满足用
JavaScript学习 -AES加密算法

引言在当今数字化时代，前端应用程序扮演着重要角色，用户的敏感数据经常在前端进行加密和解密操作。然而，这样的操作在网络传输和存储中可能会受到恶意攻击的威胁。为了确保数据
Temu起诉SHEIN，跨境电商战事升级

来源 | 伯虎财经（bohuFN）作者 | 陈平安日前据外媒报道，拼多多旗下跨境电商平台Temu正对竞争对手SHEIN提起新诉讼，诉状称Shein“利用市场支配力量强迫服装厂商与之签订独家
阿里大调整

来源：产品刘有媒体报道称，近期淘宝天猫集团启动了近年来最大的人力制度改革，涉及员工绩效、层级体系等多个核心事项，目前已形成一个初步的“征求意见版”：1、取消P序列
3699元！iQOO Neo8 Pro顶配版今日首销：1TB UFS 4.0同价位唯一

5月23日，iQOO推出了全新的iQOO Neo8系列，包含iQOO Neo8和iQOO Neo8 Pro两个版本，其中标准版搭载高通骁龙8+，而Pro版更是首发搭载了联发科天玑9200+旗舰
DRAM存储器10月价格下跌，NAND闪存本月价格与上月持平

10月30日，据韩国媒体消息，自今年年初以来一直在上涨的 DRAM 存储器的交易价格仅在本月就下跌了近 10％，此次是全年首次降价，而NAND 闪存本月价格与上月持平。市
最薄的14英寸游戏笔记本电脑 Alienware X14已可以购买

2022年1月份在国际消费电子展(CES2022)上首次亮相的Alienware新品——Alienware X14现在已经可以购买了，这款笔记本电脑被誉为世界上最薄的 14 英寸游戏笔