stc-setclass
v1.0.4
Published
A tool for converting OpenApi/Swagger/Apifox into code.
Downloads
323
Maintainers
Readme
STC
安装
将Swagger 2/3(OpenApi)的接口生成为typescript的接口文件
- 更改自@loogwoo/stc项目,将原版生成的interface类型文件修改为class类型,使用时直接new实体,将不需要再复制表单.
npm安装:
npm i stc-setclass
⚠️安装后需要在根目录下的package.json
中的scripts
添加如下配置:
"api": "stc --url=你的openApi地址 --outDir=导出目录 --client=axios --lang=ts"
例如:
{
"scripts": {
"api": "stc --url=http://127.0.0.1:4523/export/openapi/2?version=3.1 --outDir=out/api --client=axios --lang=ts"
}
}
安装并配置后运行:
npm run api
以下为原版文档:
Features
- 🐹 Support for Swagger 2/3(OpenApi) and Apifox.
- 💡 Support plug-in development.
- 🐣 Built-in transformation languages:
- TypeScript, almost equivalent to handwriting. Depends on
axios
,wx.request
,fetch
.
xhr/ajax、ofetch
planned- JavaScript, from TypeScript to it.
- Dart, dependency on
dio
. - 🚧 Swift ...
- TypeScript, almost equivalent to handwriting. Depends on
Quick start
Download executable files
download by system:
- stc: Intel-based Mac
- stc-m: M-series Mac
- stc-linux:Linux
- stc-win.exe: Windows
NPM
1.Install the @loogwoo/stc
npm package.
pnpm add @loongwoo/stc -D
2.Open the project's package.json
file and add the following command to scripts
:
{
"scripts": {
"api": "stc --url=http://127.0.0.1:4523/export/openapi/2?version=3.1"
}
}
Use
⚠️ Note: deno will not parse the ~
character as the user's home directory.
stc --url=https://petstore3.swagger.io/api/v3/openapi.json --outDir=out
Existing Project
Assume a project directory is:
.
├── src
│ └── apis # Copy the shared directory here.
│ └── shared
│ └── xxx.ts # Other files.
Axios
Find the directory of
outDir
, copy the entireshared
directory to the directory of theaxios
module you encapsulated.Open the
shared > axios > index.ts
file, copy therequest
method, and add it to theaxios
module you encapsulated. If it is not encapsulated, copy theindex.ts
file as a new file to avoid the problem of modification being overwritten.Taking
Vue
as an example, add the following code to themain.ts
file:
import { createApiClient } from './apis/shared/fetchRuntime';
createApiClient({
baseURL: 'https://api.xxx.com'
// onError(msg) {
// // 处理错误信息
// }
})
Find the directory of
outDir
, copy the entire directory ofshared
to the directory of thewechat
module you encapsulated.Open the
shared > wechat > index.ts
file, copy therequest
method, and add it to thewx.request
code file you encapsulated. If it is not encapsulated, copy theindex.ts
file as a new file to avoid the problem of modification being overwritten.Add the following code to the
app.ts
file:
import { createApiClient } from './apis/shared/fetchRuntime';
// import Notify from './miniprogram_npm/@vant/weapp/notify/notify';
App<IAppOption>({
onLaunch() {
createApiClient({
baseURL: 'https://api.xxx.com,
onError(msg) {
// Notify({ type: 'danger', message: msg, selector: '#v-notify'})
}
})
}
});
Options
| Option | Alias | Type | Default | Description |
| ----------- | ----- | -------- | --------- | ------------------------------------------------------------------------------------------------------------ |
| url | | string | | Swagger/OpenApi/Apifox document address, or local path. |
| outDir | o | string | ./stc_out | Output Directory. |
| client | | string | axios | http request client. When lang
is ts/js
, the possible values are: axios
, wechat
, fetch
. |
| lang | l | string | ts | Language, used for output file suffix. |
| tag | | number | | Specify the tag from the interface url. By default, the first tag is read for the file name. |
| filter | f | string[] | | Filter interfaces. Interfaces that meet the filter conditions will be generated. Example: --filter "/pet/*"
, generate an interface for /pet
, and support multiple --filter
|
| conjunction | c | string | By | The method's connector, the default value is By
. |
| version | v | boolean | | Output version information. |
| help | h | boolean | | Output help information. |
Plug-in development
For convenience, STC can not only develop plugins in Deno, but also provides @loongwoo/stc
npm library, which can develop plugins in Node environment.
Deno
⚠️ Prepare the Deno environment.
Create a myPlugin.ts
file:
// 引用模块
// import { start } from 'https://deno.land/x/[email protected]/mod.ts'
import { start } from 'jsr:@loongwoo/stc@^2.4.0'
// Defining plugins
const myPlugin: IPlugin = {
name: 'stc:MyPlugin',
lang: 'ts',
setup(options) {
console.log(options)
},
onTransform(def, action) {
// definition
const defContent: string = parserDefinition(
def
)
// action
const actionContent: Map<string, string> = parserAction(
action
)
return {
definition: {
filename: '_types.ts',
content: defContent,
},
action: actionContent // Here actionContent is of type Map<string, string>, key is the file name, value is the converted code.
}
},
onEnd() {
console.log('end')
}
}
// 使用插件
start({
// ...其他配置
plugins: [myPlugin]
})
Node
Create a
myPlugin.ts
file.Add the
@loongwoo/stc
reference and use thestart
method:
import { start } from '@loongwoo/stc'
- Implement the code that converts
definition
andaction
into the target language in the plugin'sonTransform
hook function.
export const myPlugin: IPlugin = {
name: 'stc:MyPlugin',
lang: 'ts',
setup(options) {
console.log(options)
},
onTransform(def, action) {
// definition
const defContent: string = parserDefinition(
def
)
// action
const actionContent: Map<string, string> = parserAction(
action
)
return {
definition: defContent,
action: actionContent
}
},
onEnd() {
console.log('end')
}
}
4.In the start
method, add plugins
:
start({
// ...other options
plugins: [myPlugin]
})