OpenApi(Swagger)快速转换成 TypeScript 代码 - STC

这篇具有很好参考价值的文章主要介绍了OpenApi(Swagger)快速转换成 TypeScript 代码 - STC。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

OpenApi(Swagger)快速转换成 TypeScript 代码 - STC

在现代的 Web 开发中,使用 OpenAPI(以前称为 Swagger)规范来描述和定义 API 已经成为一种常见的做法。OpenAPI 规范提供了一种统一的方式来描述API的结构、请求和响应,使得开发人员能够更好地理解和使用 API。

然而,手动编写与 OpenAPI 规范匹配的客户端代码或服务端框架可能是一项繁琐且耗时的任务。这就是为什么使用 STC(Swagger Transform Code)工具可以大大简化这个过程,并快速生成与 OpenAPI 规范一致的 TypeScript 代码的原因。

什么是STC(Swagger Transform Code)?

STC 是一个用于将 OpenAPI 规范的 Swagger/Apifox 文档转换为可执行代码文件的工具。它提供了一种自动化的方式来读取 OpenAPI 规范的 Swagger/Apifox 文档,并根据规范生成与之匹配的 TypeScript 代码。

特性:

  • 支持 Swagger 2, 3 和 Apifox。
  • 支持 Axios、Wechat 请求库。
  • 支持插件开发。

下载 STC

  • Windows
  • Mac Intel
  • Mac M
  • Linux

软件没有签名,在打开时会被系统安全提示,允许即可。

如何使用?

下载好后,在终端(cmd)中进入到 STC 文件所在目录。输入如下命令:

stc --url=https://petstore3.swagger.io/api/v3/openapi.json --outDir=out

需要注意的是 STC 不会识别 ~ 为用户主目录,这是由于 Deno 自身不支持。

OpenApi(Swagger)快速转换成 TypeScript 代码 - STC

OpenApi(Swagger)快速转换成 TypeScript 代码 - STC

选项

参数名 类型 默认值 说明
url string Swagger 文档地址,或者本地路径
outDir string stc_out 输出目录
platform string axios 平台,可选值:axioswechat
lang string ts 语言,用于输出文件的后缀名
tag number 从接口 url 指定标签,默认读取 tags 的第一个用于文件名
filter string[] 过滤接口,符合过滤条件的接口会被生成。eg: --filter "/pet/*",生成 /pet 的接口,同时支持多个 --filter

最后

目前工具还在完善中,后续会内置支持更多语言的插件。
如果你觉得不错,可以点个 star 表示支持一下 https://github.com/long-woo/stc。文章来源地址https://www.toymoban.com/news/detail-626782.html

到了这里,关于OpenApi(Swagger)快速转换成 TypeScript 代码 - STC的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 一文带您快速梳理ChatGPT、GPT4 和OpenAPI的关系

    最近最火的几个词无疑是ChatGPT、GPT4 和OpenAPI,那么这三者究竟有什么关系呢?本文将带您进行快速梳理! OpenAI是一家专注人工智能研究的公司,使命是确保人工智能造福全人类。官网: https://openai.com/ 目前火到爆炸的GPT-4是他们开发的一种自然语言处理模型。GPT是OpenAI的一个

    2023年04月12日
    浏览(54)
  • visual studio代码解析(注释)英文换成中文

    我们用visual studio看别人代码或者看函数不知道意思的时候,看官方提示,又是全英文看不懂,这种情况换成中文就会很大提高代码书写效率,大家也可以去看官方文档是怎么教我们做的https://docs.microsoft.com/zh-cn/dotnet/core/install/localized-intellisense 官方文档中是拿NET5.0示例的,打

    2024年02月10日
    浏览(43)
  • Warshall算法(用法详解,并转换成代码的形式)

    关于Warshall算法,我先通过离散数学中求传递闭包来解释他的使用规则。 一般的,给定一个矩阵A(行列相等),我们对其使用Warshall算法: //注,该矩阵上只有0或1两种元素,做加法时,1+1还是1 1、先找到该矩阵的对角线,并从对角线的左上方开始为第一个元素 2、以对角线上

    2024年02月01日
    浏览(35)
  • visual studio代码解析(注释)英文换成中文包

    前文:我们用visual studio看别人代码或者看函数不知道意思的时候,看官方提示,又是全英文看不懂,这种情况换成中文就会很大提高代码书写效率,大家也可以去看官方文档是怎么教我们做的https://docs.microsoft.com/zh-cn/dotnet/core/install/localized-intellisense 下载中文包 解压后得到下

    2024年02月13日
    浏览(53)
  • OpenApi接口的一次调用经历(附代码)

    去弄一个api_key:https://platform.openai.com/account/api-keys   先看所有能用的模型: 返回: babbage davinci text-davinci-edit-001 babbage-code-search-code text-similarity-babbage-001 code-davinci-edit-001 text-davinci-001 ada curie-instruct-beta babbage-code-search-text babbage-similarity whisper-1 code-search-babbage-text-001 text-curie-

    2024年02月12日
    浏览(50)
  • swagger使用教程——快速使用swagger

    一、swagger简介 官网:https://swagger.io/ 1、认识swagger swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RestFul风格的web服务,总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器断的代码,允许API来始终保持

    2023年04月23日
    浏览(40)
  • Swagger转换成Excel文件

    1、添加swagger解析依赖包: 2、示例代码: 3、打印信息样例 4、导出Excel样例

    2024年04月11日
    浏览(28)
  • Flink系列Table API和SQL之:动态表、持续查询、将流转换成动态表、更新查询、追加查询、将动态表转换为流、更新插入流(Upsert)

    Flink中使用表和SQL基本上跟其他场景是一样的。不过对于表和流的转换,却稍显复杂。当我们将一个Table转换成DataStream时,有\\\"仅插入流\\\"(Insert-Only Streams)和\\\"更新日志流\\\"(Changelog Streams)两种不同的方式,具体使用哪种方式取决于表中是否存在更新操作。 这种麻烦其实是不可避

    2024年02月03日
    浏览(75)
  • Swagger快速上手

    快速开始: 导入maven包 在启动类配置 1、前后端分离: Vue + Springboot 开发模式 后端时代:前端只用管理静态页面;html—后端。模板引擎 JSP—后端是主力 2、前后端分离时代: 前端 :前端控制层、视图层【前端团队】 后端:后端控制层、服务层、数据访问层【后端团队】 前

    2024年02月04日
    浏览(72)
  • swagger3 快速整合 springboot 2.6.15

    2024年02月11日
    浏览(38)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包