在現(xiàn)代的 Web 開發(fā)中，使用 OpenAPI（以前稱為 Swagger）規(guī)范來描述和定義 API 已經(jīng)成為一種常見的做法。OpenAPI 規(guī)范提供了一種統(tǒng)一的方式來描述API的結(jié)構(gòu)、請求和響應(yīng)，使得開發(fā)人員能夠更好地理解和使用 API。
然而，手動(dòng)編寫與 OpenAPI 規(guī)范匹配的客戶端代碼或服務(wù)端框架可能是一項(xiàng)繁瑣且耗時(shí)的任務(wù)。這就是為什么使用 STC（Swagger Transform Code）工具可以大大簡化這個(gè)過程，并快速生成與 OpenAPI 規(guī)范一致的 TypeScript 代碼的原因。
什么是STC（Swagger Transform Code）？
STC 是一個(gè)用于將 OpenAPI 規(guī)范的 Swagger/Apifox 文檔轉(zhuǎn)換為可執(zhí)行代碼文件的工具。它提供了一種自動(dòng)化的方式來讀取 OpenAPI 規(guī)范的 Swagger/Apifox 文檔，并根據(jù)規(guī)范生成與之匹配的 TypeScript 代碼。
特性：
- 支持 Swagger 2, 3 和 Apifox。
- 支持 Axios、Wechat 請求庫。
- 支持插件開發(fā)。
下載 STC
- Windows
- Mac Intel
- Mac M
- Linux
軟件沒有簽名，在打開時(shí)會被系統(tǒng)安全提示，允許即可。
如何使用？
下載好后，在終端（cmd）中進(jìn)入到 STC 文件所在目錄。輸入如下命令：
stc --url=https://petstore3.swagger.io/api/v3/openapi.json --outDir=out
需要注意的是 STC 不會識別
~為用戶主目錄，這是由于 Deno 自身不支持。
文章來源：http://www.zghlxwxcb.cn/news/detail-626782.html
選項(xiàng)
| 參數(shù)名 | 類型 | 默認(rèn)值 | 說明 |
|---|---|---|---|
| url | string | Swagger 文檔地址，或者本地路徑 | |
| outDir | string | stc_out | 輸出目錄 |
| platform | string | axios | 平臺，可選值：axios、wechat
|
| lang | string | ts | 語言，用于輸出文件的后綴名 |
| tag | number | 從接口 url 指定標(biāo)簽，默認(rèn)讀取 tags 的第一個(gè)用于文件名 | |
| filter | string[] | 過濾接口，符合過濾條件的接口會被生成。eg: --filter "/pet/*"，生成 /pet 的接口，同時(shí)支持多個(gè) --filter
|
最后
目前工具還在完善中，后續(xù)會內(nèi)置支持更多語言的插件。
如果你覺得不錯(cuò)，可以點(diǎn)個(gè) star 表示支持一下 https://github.com/long-woo/stc。文章來源地址http://www.zghlxwxcb.cn/news/detail-626782.html
到了這里，關(guān)于OpenApi（Swagger）快速轉(zhuǎn)換成 TypeScript 代碼 - STC的文章就介紹完了。如果您還想了解更多內(nèi)容，請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
