Skip to content

senfish/github-stt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

swagger 自动生成ts类型工具

最小案例复现

安装依赖

npm install

基于origin.yaml生成 ts 类型文件,默认在src/@types目录下生成类型文件,配合 cli 一起使用,功能更丰富

npm start

cli 使用

参数介绍

  ls                       List all the config
  use [name]               Use config name
  add [name] [value]       Add config
  rename <name> <newName>  Rename config name
  del [name]               Delete config name
  set-dir [name]           Set output dir value
  get [name]               Get config info
  update [name]            Generate .d.ts file
  help [command]           display help for command

stt add 添加配置

$ stt add bb-admin http://example.com:8002

stt ls 查看配置

$ stt ls

  bb-admin ----------- http://example.com:8002

stt use 使用配置

$ stt use bb-admin

再用ls命令查看一下

$ stt ls

* bb-admin --------- http://example.com:8002

stt rename 修改配置名称

$ stt rename bb-admin bb-admin-new

ls 查看一下

* bb-admin-new ----- http://example.com:8002

stt del 删除配置

$ stt add test http://test.com

$ stt ls

* bb-admin-new ----- http://example.com:8002
  test ------------- http://test.com

$ stt del test
$ stt ls

* bb-admin-new ----- http://example.com:8002

stt set-dir 设置 ts 类型文件输出目录

默认目录为src/@types,也支持自定义目录。

// 查看一下输出文件目录
$ stt get dir

src/@types

$ stt set-dir src/demo

设置之后,ts 类型文件会默认输出到当前路径的src/demo目录下。

(主要功能)stt update

根据配置的 dir 文件目录,和当前使用的配置,生成对应的.d.ts 文件。

stt get 获取配置信息

$ stt get dir
src/@types

About

swagger-to-ts

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published