STC

logo

STC(Swagger Transform Code) 是一个 Swagger 文档转换成代码文件的工具。

Publish

特性：

  • 支持 Swagger 2、3。

  • 支持 Apifox。

  • 支持 Axios、Wechat。

  • 支持插件开发。

  • 内置转换语言：

    • TypeScript，几乎等同于手写。
    • ...

快速开始

按系统下载：

  • stc：Intel 系列的 Mac
  • stc-m：M 系列的 Mac
  • stc-linux：Linux
  • stc-win.exe: Windows

使用

⚠️ 注意：deno 不会解析 ~字符为用户主目录。

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

终端输出信息

输出文件

选项

参数名 类型 默认值 说明
url string Swagger 文档地址，或者本地路径
outDir string stc_out 输出目录
platform string axios 平台，可选值：axios、wechat
lang string ts 语言，用于输出文件的后缀名
tag number 从接口指定标签，默认读取 tags 的第一个用于文件名

插件开发

为了方便，STC 不仅可以在 Deno 中开发插件，同时也提供了 @loongwoo/stc npm 库，可以在 Node 环境中开发插件。

查看示例代码

Deno 方式

⚠️ 准备 Deno 环境

创建一个 myPlugin.ts 文件：

// 引用模块
import { start } from 'https://deno.land/x/stc@1.1.4/mod.ts'

// 定义插件
const myPlugin: IPlugin = {
  name: "stc:MyPlugin",
  setup(options) {
    console.log(options)
  },
  onTransform(def, action) {
    // 转换 definition
    const defContent: string = parserDefinition( def /* 这里的 def 是 Definition 对象 */)
    // 转换 action
    const actionContent: Map<string, string> = parserAction(action /* 这里的 action 是 Action 对象 */)
    // 返回转换后的内容
    return {
      definition: defContent,
      action: actionContent // 这里的 actionContent 是 Map<string, string> 类型，key 是文件名称，value 是转换后的代码
    }
  }
}

// 使用插件
start({
  // ...其他配置
  plugins: [myPlugin]
})

Node 方式

1.创建一个 myPlugin.ts 文件。

2.添加 @loongwoo/stc 引用，使用 start 方法：

import { start } from '@loongwoo/stc'

3.在插件的 onTransform 钩子函数中实现将 definition 和 action 转换为目标语言的代码。

export const myPlugin: IPlugin = {
  name: "stc:MyPlugin",
  setup(options) {
    console.log(options)
  },
  onTransform(def, action) {
    // 转换 definition
    const defContent: string = parserDefinition(def /* 这里的 def 是 Definition 对象 */)
    // 转换 action
    const actionContent: Map<string, string> = parserAction(action /* 这里的 action 是 Action 对象 */)
    // 返回转换后的内容
    return {
      definition: defContent,
      action: actionContent
    }
  }
}

4.在 start 方法里，添加 plugins:

start({
  // ...其他配置
  plugins: [myPlugin]
})