openapi-generate-config

run openapi-typescript by config

Source

npm

Version: 3.3.4

Version published: 5 years ago

Weekly downloads: 2

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

openapi-generate-config

根据 swagger api-doc 自动生成 typescript 类型文件、请求函数

特性

根据 controller 自动生成请求文件目录
根据请求路径生成请求函数
自动生成工具泛型用于推导类型
可自定义配置类型、文件生成目录
request 请求使用 umi-request 如果包中有 tarojs 请求库更换为项目内封装的请求工具

再也不必自己定义请求类型请求方法

Step 1

安装插件

# Yarn
yarn add openapi-generate-config --dev

# Npm
npm install openapi-generate-config --save-dev

Step 2

生成、读取文件

npx openapi-make

如果项目根目录没有配置文件,执行命令后会会生成一个generateTypeBySwagger.json的文件，内容如下：

{
  "doc": "请参考README.md,https://github.com/leesama/openapi-generate-config#readme",
  // 根据数组配置生成文件
  "generateConfig": [
    {
      // 目录名
      "dirName": "B",
      // 请求url的前缀
      "urlPrefix": "/api",
      // 当后端返回值中数据字段不为data时,指定其字段名,用于工具泛型推导data的类型
      "dataMapping": "result",
      "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"
    },
    {
      "dirName": "A",
      "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"
    }
  ]
}