runtime-generated-type

Generates typescript code when sending the request interface.

Install

$ npm install --save-dev runtime-generated-type

Getting Started

• vite

import { defineConfig } from 'vite'
import {createRuntimeGeneratedType} from 'runtime-generated-type'
import path from 'path'

export default defineConfig({
  server: {
    proxy: {
      '/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/api/, ''),
        configure: createRuntimeGeneratedType({
          dataSource: '', // 指定接口返回数据的位置
          outputPath: path.resolve(__dirname, './src/types.ts'),
          baseUrl: '/api/*',
        }),
      },
    }
  }
})

• react-create-app -> setupProxy.js

const path = require('path')
// "http-proxy-middleware": "3.0.0-beta.1"
const {createProxyMiddleware} = require('http-proxy-middleware')
const {createRuntimeGeneratedType} = require('runtime-generated-type')

const runtimeGeneratedTypePlugin = createRuntimeGeneratedType({
  dataSource: '', // 指定接口返回数据的位置
  outputPath: path.resolve(__dirname, './types.ts'),
  baseUrl: '/api/*',
})

module.exports = function(app) {
  app.use(
    createProxyMiddleware({
      pathFilter: '/api',
      target: 'http://jsonplaceholder.typicode.com',
      changeOrigin: true,
      pathRewrite: {'^/api' : ''},
      plugins: [runtimeGeneratedTypePlugin],
    })
  );
};

Configuration

参数	类型	必填	参数说明	示例
outputPath	String	true	生成文件路径	path.resolve(__dirname, './src/types.ts')
baseUrl	String	true	配置请求接口地址的统一前缀	'/api/*' (*号自动匹配任意字符)
dataSource	String	false	指定生成类型数据源位置	'data.item'
genOnce	Boolean	false	每个接口仅生成一次类型
matching	Array	false	匹配动态参数请求接口	['/posts/*/comments']
prefix	boolean	false	typeName 添加前缀	Get | Post | Put | Delete ...

Request url to generate type name matching rules

• GET: /api/v1/team/department/frontGroup/:id -> TeamDepartmentFrontGroup
• GET: /api/v1/team/department/endGroup/:id -> TeamDepartmentEndGroup
• GET: /api/v1/team/department/endGroup/:id/details -> TeamDepartmentEndGroupDetails
• GET: /api/v1/teamMember -> GetTeamMember
• PUT: /api/v1/teamMember -> PutTeamMember
• DELETE: /api/v1/teamMember -> DeleteTeamMember
• POST: /api/workflow/:id/inter/search -> PostWorkflowInterSearch
• POST: /api/system/:id/inter/search -> PostSystemInterSearch
• GET: /api/user/:id/inter/search -> GetUserInterSearch

License

MIT License © 2023 Proc Zhang