1.0.1 • Published 9 months ago

swaggerapi-typescript-api v1.0.1

Weekly downloads
-
License
-
Repository
-
Last release
9 months ago

swaggerapi-typescript-api

根据服务端swagger文档,自动生成ts定义和api接口代码,节省大量写接口的时间,目前测试的是swagger 2.x版本的文档,同理如果有需要只需升级openapi-typescript,然后做相应转换调整

使用

安装

yarn add swaggerapi-typescript-api -D

使用

  1. 新建配置文件apiConfig.js
  const { swaggerapiTs } = require('swaggerapi-typescript-api')

  swaggerapiTs([
    {
      url: 'http://172.17.13.80:8090/ls-commoditymain/v2/api-docs',
      fileName: 'ls-commoditymain'
    },
    {
      url: 'http://172.17.13.9:9999/activity-app/v2/api-docs',
      fileName: 'activity-app'
    }
  ]);
  1. 添加package.json命令
  "scripts": {
    "api": "node ./apiConfig.js"
  },
  1. 执行命令
  yarn api

axiosInstance.ts

  • 会自动生成axios的示例文件axiosInstance.ts,该文件只会生成一次
  • 可以直接在该文件下添加各种拦截器

options[]

参数说明类型是否必传默认值版本
urlSwagger Api 文档地址String*
fileName输出的文件名字,一般对应服务端应用名stringapi*
output输出目录,注意输出目录需要手动新建stringapi*

举例

alt alt alt alt