TypeSpec[1] 是一種高度可擴(kuò)展的語(yǔ)言，可輕松描述 REST、OpenAPI、gRPC 和其他協(xié)議中常見的 API 結(jié)構(gòu)。TypeSpec 在生成多種不同的 API 描述格式、客戶端和服務(wù)端代碼、文檔等方面表現(xiàn)出色。有了 TypeSpec，你就可以擺脫那些拖慢你速度的手寫文件，并在幾秒鐘內(nèi)生成符合標(biāo)準(zhǔn)的 API Schemas。
圖片
圖片
圖片
要快速體驗(yàn) TypeSpec 的功能，推薦你使用 TypeSpec 官方提供的 playground[2]。該 playground 預(yù)設(shè)了 API versioning、Discriminated unions、HTTP service、REST framework、Protobuf Kiosk 和 Json Schema 6 個(gè)不同的使用示例，并支持 File 和 Swagger UI 兩種視圖。
圖片
圖片
npm install -g @typespec/compiler在 VSCode 中搜索 TypeSpec 安裝 TypeSpec for VS Code 擴(kuò)展，或在瀏覽器中打開 TypeSpec for VS Code[3] 網(wǎng)址后點(diǎn)擊 Install 按鈕。
首先新建一個(gè)新的目錄，然后在項(xiàng)目的根目錄下執(zhí)行以下命令：
tsp init
圖片
圖片
tsp install成功執(zhí)行上述命令后，在當(dāng)前目錄下會(huì)生成以下目錄結(jié)構(gòu)：
.├── 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;}完成輸入后，運(yùn)行 tsp compile . 命令執(zhí)行編譯操作。成功編譯后，在 tsp-output/@typespec/openapi3 目錄下就會(huì)生成 openapi.yaml 文件：
圖片
有關(guān) TypeSpec 的相關(guān)內(nèi)容就介紹到這里，如果你想進(jìn)一步了解 TypeSpec 的基礎(chǔ)使用和高級(jí)用法，推薦你閱讀官方的使用文檔[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://m.www897cc.com/showinfo-26-81739-0.html受 TypeScript 啟發(fā)，微軟又搞了一個(gè)神器！
聲明：本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí)，若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系，我們將在第一時(shí)間刪除處理。郵件：2376512515@qq.com
Copyright ? 2016-2023 天津谷騏科技有限公司 版權(quán)所有 sitemap.xml
違法及侵權(quán)請(qǐng)聯(lián)系：2376512515@qq.com 津ICP備18001702號(hào)
津公網(wǎng)安備 12010102000574號(hào)