orval

根据waareger/openapi3 生成typescript 类型文件

orval能够从任何有效的 OpenAPI v3 或 Swagger v2 规范生成具有适当类型签名 (TypeScript) 的客户端，无论是格式yaml还是json格式。

安装

npm i orval -D

yarn add orval - D

配置

 orval --input ./petstore.yaml --output ./src/petstore.ts

创建配置文件

 $ orval --config ./orval.config.js
 # or
 $ orval

文件 orval.config.js

 module.exports = {
   'petstore-file': {
     input: './petstore.yaml', // url地址
     output: './src/petstore.ts', //输出的地址
   },
 };

model方式

import { defineConfig } from 'orval';

export default defineConfig({
  admin: {
    output: {
      mode: 'split',
      target: './libs/admin-shared/src/endpoints/index.ts',
      schemas: './libs/admin-shared/src/model',
      client: 'react-query',
   
    input: {
      target:'urlname',
    },
  },
});

重新生成

yarn orval    or orval