@tcatche/swagger-ts

1.0.6 • Public • Published

@tcatche/swagger-ts

Swagger to axios ts Codegen,适配 swagger2.0 版本

Installation

npm install @tcatche/swagger-ts --dev

Generate

Using JSON file

const fs = require('fs')
const path = require('path')
const swagger2ts = require('@tcatche/swagger-ts')
const json = require('./origin.json')

swagger2ts.generate(json).then(codeResult => {
  fs.writeFileSync(path.join(__dirname, `result.ts`), codeResult)
}).catch(console.log)

Using JSON URL

const fs = require('fs')
const path = require('path')
const swagger2ts = require('@tcatche/swagger-ts')
const jsonUrl = 'http://api.xx.com/xx.json'

swagger2ts.generate(jsonUrl).then(codeResult => {
  fs.writeFileSync(path.join(__dirname, `result.ts`), codeResult)
}).catch(console.log)

自动保存文件

swagger2ts.generate 第二个参数传入保存的文件名的绝对路径(文件后缀不能省略),则生成完会保存文件:

const fs = require('fs')
const path = require('path')
const swagger2ts = require('@tcatche/swagger-ts')
const jsonUrl = 'http://api.xx.com/xx.json'

swagger2ts.generate(jsonUrl, '/home/works/api/result.ts').catch(console.log)

会把生成的内容保存在 /home/works/api/result.ts

License

MIT

changelog

1.0.1

初始化版本

1.0.2

删除一些无用文件

1.0.3

优化枚举值类型

1.0.4

Features:

  • 增加文件自动保存的支持

Fixes:

  • 修复枚举值类型为字符串时错误
  • 去掉类型名中的空格
  • 修复重复的类型定义

1.0.5

Features:

  • 去掉一些无用的代码,调整一些逻辑

1.0.6

Fixes:

  • 修改文档中的错误

Package Sidebar

Install

npm i @tcatche/swagger-ts

Weekly Downloads

2

Version

1.0.6

License

MIT

Unpacked Size

1.83 MB

Total Files

25

Last publish

Collaborators

  • tcatche