feat: request file generate support parame type,and post method for f…

…ix query data
liangskyli · Jul 10, 2022 · 4282057 · 4282057
1 parent 28e6ae2
commit 4282057
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 19 deletions.
diff --git a/packages/openapi-gen-ts/src/gen/gen-interface-file.ts b/packages/openapi-gen-ts/src/gen/gen-interface-file.ts
@@ -1,29 +1,35 @@
 import { colors, prettierData } from '@liangskyli/utils';
 import fs from 'fs-extra';
 import path from 'path';
-import type prettier from 'prettier';
 import { fileTip, packageName } from '../utils';
+import type { IGenTsDataOpts } from './index';
 
 type IOpts = {
   genSchemaAPIAbsolutePath: string;
-  prettierOptions?: prettier.Options;
-  requestFilePath?: string;
-  requestQueryOmit: string[];
-  requestBodyOmit: string[];
-};
+} & Pick<
+  IGenTsDataOpts,
+  | 'prettierOptions'
+  | 'requestFilePath'
+  | 'requestParamsType'
+  | 'requestQueryOmit'
+  | 'requestBodyOmit'
+>;
 
 const genInterfaceFile = async (opts: IOpts) => {
   const {
     genSchemaAPIAbsolutePath,
     prettierOptions,
     requestFilePath,
-    requestQueryOmit,
-    requestBodyOmit,
+    requestQueryOmit = [],
+    requestBodyOmit = [],
   } = opts;
+  let { requestParamsType = '' } = opts;
 
   if (!requestFilePath) {
+    requestParamsType = 'AxiosRequestConfig';
     const requestData: string[] = [];
     requestData.push(`${fileTip}
+    import type { AxiosRequestConfig } from 'axios';
     import axios from 'axios';
     import type { IAPIRequest } from '${packageName}';
     
@@ -32,6 +38,7 @@ const genInterfaceFile = async (opts: IOpts) => {
     };
     
     export default request;
+    export { AxiosRequestConfig };
   `);
     const requestDataAbsolutePath = path.join(genSchemaAPIAbsolutePath, 'request.ts');
     fs.writeFileSync(
@@ -49,6 +56,13 @@ const genInterfaceFile = async (opts: IOpts) => {
 
   const requestAPI: string[] = [];
   requestAPI.push(`${fileTip}
+  ${
+    requestParamsType !== ''
+      ? `import type {${requestParamsType} } from '${
+          requestFilePath ? requestFilePath : './request'
+        }';`
+      : ''
+  } 
    import request from '${requestFilePath ? requestFilePath : './request'}';
    import type { IApi } from './interface-api';
   `);
@@ -85,9 +99,9 @@ const genInterfaceFile = async (opts: IOpts) => {
       ) {
         responseMediaType = 'text/plain';
       }
-      haveQuery = !!itemValue.get?.properties?.parameters?.properties?.query?.properties;
+      haveQuery = !!itemValue.post?.properties?.parameters?.properties?.query?.properties;
       haveBody =
-        itemValue.post?.properties?.requestBody?.properties?.content?.properties?.['text/plain'];
+        !!itemValue.post?.properties?.requestBody?.properties?.content?.properties?.['text/plain'];
       if (haveBody) {
         bodyMediaType = 'text/plain';
       } else {
@@ -100,17 +114,33 @@ const genInterfaceFile = async (opts: IOpts) => {
     if (method) {
       const IConfigT: string[] = [];
       if (haveQuery || haveBody) {
-        IConfigT.push('Omit<T, ');
+        IConfigT.push('Omit<T');
+        if (requestParamsType !== '') {
+          IConfigT.push(` & ${requestParamsType}, 'method' | 'url'`);
+        } else {
+          IConfigT.push(', ');
+        }
         if (haveQuery) {
-          IConfigT.push('"params"');
+          if (requestParamsType !== '') {
+            IConfigT.push('| "params"');
+          } else {
+            IConfigT.push('"params"');
+          }
         }
         if (haveBody) {
-          if (haveQuery) {
-            IConfigT.push(' | ');
+          if (requestParamsType !== '') {
+            IConfigT.push('| "data"');
+          } else {
+            IConfigT.push('"data"');
           }
-          IConfigT.push('"data"');
         }
         IConfigT.push('>,');
+      } else {
+        if (requestParamsType !== '') {
+          IConfigT.push(`Omit<T & ${requestParamsType}, 'method' | 'url'>,`);
+        } else {
+          IConfigT.push('T,');
+        }
       }
 
       interfaceAPIType.push(`'${item}': {`);

diff --git a/packages/openapi-gen-ts/src/gen/index.ts b/packages/openapi-gen-ts/src/gen/index.ts
@@ -22,6 +22,10 @@ export type IGenTsDataOpts = {
    * 需要注意的是此文件必须是使用 export default 默认导出
    */
   requestFilePath?: string;
+  /**
+   * 请求库文件里导出的请求库方法入参类型定义名称（非默认导出）
+   */
+  requestParamsType?: string;
   requestQueryOmit?: string[];
   requestBodyOmit?: string[];
 };
@@ -32,8 +36,9 @@ const genTsData = async (opts: IGenTsDataOpts) => {
     openapiPath,
     prettierOptions,
     requestFilePath,
-    requestQueryOmit = [],
-    requestBodyOmit = [],
+    requestParamsType,
+    requestQueryOmit,
+    requestBodyOmit,
   } = opts;
 
   const genTsPath = path.join(genTsDir, 'schema-api');
@@ -70,6 +75,7 @@ const genTsData = async (opts: IGenTsDataOpts) => {
     genSchemaAPIAbsolutePath: genTsAbsolutePath,
     prettierOptions: copyOptions(prettierOptions),
     requestFilePath,
+    requestParamsType,
     requestQueryOmit,
     requestBodyOmit,
   });

diff --git a/packages/openapi-gen-ts/test/http/gen.ts b/packages/openapi-gen-ts/test/http/gen.ts
@@ -4,8 +4,9 @@ import genTsData from '../../src/index';
 genTsData({
   genTsDir: './test/gen-ts-dir',
   openapiPath: './test/openapi/openapiv3-example.json',
-  //requestFilePath: '../../http/request',
+  requestFilePath: '../../http/request',
   //requestFilePath: path.join(__dirname, './request'),
+  requestParamsType: 'AxiosRequestConfig',
   //requestQueryOmit: ['activityId','b'],
   //requestBodyOmit: ['a','b'],
 }).then();
diff --git a/packages/openapi-gen-ts/test/http/request.ts b/packages/openapi-gen-ts/test/http/request.ts
@@ -1,8 +1,10 @@
 import type { AxiosRequestConfig } from 'axios';
 import axios from 'axios';
+import type { IAPIRequest } from '@liangskyli/openapi-gen-ts';
 
-const request = (config: AxiosRequestConfig) => {
+const request: IAPIRequest = (config) => {
   return axios(config).then((res) => res.data);
 };
 
 export default request;
+export { AxiosRequestConfig };
diff --git a/packages/openapi-gen-ts/test/openapi/openapiv3-example.json b/packages/openapi-gen-ts/test/openapi/openapiv3-example.json
@@ -527,6 +527,16 @@
             }
           }
         },
+        "parameters": [
+          {
+            "name": "queryParam1",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/IParam1"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "application/json": {
@@ -1403,6 +1413,16 @@
             }
           }
         },
+        "parameters": [
+          {
+            "name": "queryParam1",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "number"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "text/plain": {