Merge pull request #612 from openapi-ui/feat/config-props-validate

perf: perf config props validate

Author: rookie-luochao

.changeset/wide-nails-mix.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+perf: perf config props validate

README-en_US.md

@@ -225,7 +225,8 @@ openapi -i ./spec.json -o ./apis
 
 | props | required | type | default | remark |
 | --- | --- | --- | --- | --- |
-| schemaPath | yes | string | - | Swagger2/OpenAPI3 URL |
+| schemaPath | no\* | string | - | Swagger2/OpenAPI3 URL (mutually exclusive with apifoxConfig, one of them is required) |
+| apifoxConfig | no\* | [Apifox Config](#Apifox-Config) | - | apifox configs (mutually exclusive with schemaPath, one of them is required) |
 | serversPath | no | string | './src/apis' | the folder path for the run results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
 | isSplitTypesByModule | no | boolean | false | split types by module, generates {module}.type.ts (module types), common.type.ts (common types), enum.ts (enum types), types.ts (unified export) |
@@ -248,7 +249,6 @@ openapi -i ./spec.json -o ./apis
 | isGenJsonSchemas | no | boolean | false | generate JSON Schemas |
 | mockFolder | no | string | - | mock file path, for example: './mocks' |
 | authorization | no | string | - | docs authorization |
-| apifoxConfig | no | [Apifox Config](#Apifox-Config) | - | apifox configs |
 | nullable | no | boolean | false | null instead of optional |
 | isTranslateToEnglishTag | no | boolean | false | translate chinese tag name to english tag name |
 | isOnlyGenTypeScriptType | no | boolean | false | only generate typescript type |

README.md

@@ -225,7 +225,8 @@ openapi --i ./spec.json --o ./apis
 
 | 属性 | 必填 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
+| schemaPath | 否\* | string | - | Swagger2/OpenAPI3 地址（与 apifoxConfig 互斥，两者必填其一） |
+| apifoxConfig | 否\* | [Apifox Config](#Apifox-Config) | - | apifox 配置（与 schemaPath 互斥，两者必填其一） |
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
 | isSplitTypesByModule | 否 | boolean | false | 按模块拆分类型文件，开启后会生成：{module}.type.ts（各模块类型）、common.type.ts（公共类型）、enum.ts（枚举类型）、types.ts（统一导出） |
@@ -248,7 +249,6 @@ openapi --i ./spec.json --o ./apis
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | - | mock文件路径，例如：'./mocks' |
 | authorization | 否 | string | - | 文档权限凭证 |
-| apifoxConfig | 否 | [Apifox Config](#Apifox-Config) | - | apifox 配置 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |

agents.md

@@ -40,7 +40,8 @@ else if (isNodeProject) {
 
 | Configuration | Type | Default | Description | When to Use |
 | --- | --- | --- | --- | --- |
-| `schemaPath` | string | **required** | OpenAPI/Swagger spec URL or file path | Always required |
+| `schemaPath` | string | - | OpenAPI/Swagger spec URL or file path | Use when providing OpenAPI spec URL/file path (mutually exclusive with apifoxConfig) |
+| `apifoxConfig` | object | - | Apifox configuration | Use when fetching spec from Apifox (mutually exclusive with schemaPath) |
 | `serversPath` | string | `"./src/apis"` | Output directory for generated files | Custom output location |
 | `requestLibPath` | string | `"axios"` | HTTP client library path | Custom request client |
 | `full` | boolean | `true` | Full replacement vs incremental | Incremental updates |

package.json

@@ -32,7 +32,7 @@
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
     "test:unit": "vitest",
     "prepare": "husky",
-    "openapi-ts-request": "openapi-ts"
+    "openapi-ts-request": "openapi"
   },
   "dependencies": {
     "@clack/prompts": "^0.11.0",

src/bin/cli.ts

@@ -6,6 +6,7 @@ import type { GenerateServiceProps } from '../index';
 import { generateService } from '../index';
 import { logError } from '../log';
 import { readConfig } from '../readConfig';
+import { createMultiselectOptions } from './utils';
 
 program
   .option('-cfn, --configFileName <string>', 'config file name')
@@ -44,18 +45,17 @@ async function run() {
         intro('🎉 欢迎使用 openapi-ts-request 生成器');
         const selected = await multiselect({
           message: '请选择要生成的 service',
-          options: configs.map((config) => ({
-            value: config,
-            label: config.describe || config.schemaPath,
-          })),
+          options: createMultiselectOptions(configs) as Parameters<
+            typeof multiselect
+          >[0]['options'],
         });
 
         if (isCancel(selected)) {
           cancel('👋 Has cancelled');
           process.exit(0);
         }
 
-        configs = selected;
+        configs = selected as GenerateServiceProps[];
       }
 
       for (const config of configs) {
@@ -70,7 +70,9 @@ async function run() {
 
         if (result.status === 'rejected') {
           const cnf = configs[i];
-          const label = cnf.describe || cnf.schemaPath;
+          const label =
+            cnf.describe ||
+            ('schemaPath' in cnf ? cnf.schemaPath : 'Apifox Config');
           errorMsg += `${label}${label && ':'}${result.reason}\n`;
         }
       }

src/bin/openapi.ts

@@ -10,6 +10,7 @@ import { generateService } from '../index';
 import { logError } from '../log';
 import { readConfig } from '../readConfig';
 import type { IPriorityRule, IReactQueryMode } from '../type';
+import { createMultiselectOptions } from './utils';
 
 const params = program
   .name('openapi')
@@ -194,20 +195,20 @@ async function run() {
 
         console.log(''); // 添加一个空行
         intro('🎉 欢迎使用 openapi-ts-request 生成器');
+
         const selected = await multiselect({
           message: '请选择要生成的 service',
-          options: configs.map((config) => ({
-            value: config,
-            label: config.describe || config.schemaPath,
-          })),
+          options: createMultiselectOptions(configs) as Parameters<
+            typeof multiselect
+          >[0]['options'],
         });
 
         if (isCancel(selected)) {
           cancel('👋 Has cancelled');
           process.exit(0);
         }
 
-        configs = selected;
+        configs = selected as GenerateServiceProps[];
       }
 
       for (const config of configs) {
@@ -222,7 +223,9 @@ async function run() {
 
         if (result.status === 'rejected') {
           const cnf = configs[i];
-          const label = cnf.describe || cnf.schemaPath;
+          const label =
+            cnf.describe ||
+            ('schemaPath' in cnf ? cnf.schemaPath : 'Apifox Config');
           errorMsg += `${label}${label && ':'}${result.reason}\n`;
         }
       }

src/bin/utils.ts

@@ -0,0 +1,15 @@
+import type { GenerateServiceProps } from '../index';
+
+/**
+ * Helper function to create multiselect options with proper typing
+ */
+export function createMultiselectOptions(
+  configs: GenerateServiceProps[]
+): Array<{ value: GenerateServiceProps; label: string }> {
+  return configs.map((config) => ({
+    value: config,
+    label:
+      config.describe ||
+      ('schemaPath' in config ? config.schemaPath : 'Apifox Config'),
+  }));
+}

src/index.ts

@@ -14,6 +14,7 @@ import type {
   ComponentsObject,
   IPriorityRule,
   IReactQueryMode,
+  MutuallyExclusive,
   OpenAPIObject,
   OperationObject,
   ReferenceObject,
@@ -29,11 +30,7 @@ import {
 
 export * from './generator/patchSchema';
 
-export type GenerateServiceProps = {
-  /**
-   * Swagger2/OpenAPI3 地址
-   */
-  schemaPath: string;
+export type GenerateServicePropsBase = {
   /**
    * 生成的文件夹的路径
    */
@@ -141,10 +138,6 @@ export type GenerateServiceProps = {
    * 文档权限凭证
    */
   authorization?: string;
-  /**
-   * apifox 配置
-   */
-  apifoxConfig?: GetSchemaByApifoxProps;
   /**
    * 默认为false，true时使用null代替可选值
    */
@@ -365,6 +358,21 @@ export type GenerateServiceProps = {
   };
 };
 
+/**
+ * Swagger2/OpenAPI3 地址或 Apifox 配置，两者必须填写一个
+ */
+export type GenerateServiceProps = GenerateServicePropsBase &
+  MutuallyExclusive<{
+    /**
+     * Swagger2/OpenAPI3 地址
+     */
+    schemaPath: string;
+    /**
+     * apifox 配置
+     */
+    apifoxConfig: GetSchemaByApifoxProps;
+  }>;
+
 export async function generateService({
   requestLibPath,
   schemaPath,
@@ -382,7 +390,15 @@ export async function generateService({
   ...rest
 }: GenerateServiceProps) {
   if (!schemaPath && !apifoxConfig) {
-    return;
+    throw new Error(
+      'Either schemaPath or apifoxConfig must be provided. Please provide at least one configuration option.'
+    );
+  }
+
+  if (schemaPath && apifoxConfig) {
+    throw new Error(
+      'schemaPath and apifoxConfig cannot be provided at the same time. Please provide only one configuration option.'
+    );
   }
 
   let openAPI: OpenAPIObject | null = null;
@@ -415,7 +431,7 @@ export async function generateService({
   const requestImportStatement = getImportStatement(requestLibPath);
   const serviceGenerator = new ServiceGenerator(
     {
-      schemaPath,
+      ...(schemaPath ? { schemaPath } : { apifoxConfig }),
       serversPath: './src/apis',
       requestImportStatement,
       enableLogging: false,
@@ -447,7 +463,7 @@ export async function generateService({
       isSupportParseEnumDesc: false,
       full: true,
       ...rest,
-    },
+    } as GenerateServiceProps,
     openAPI
   );
   serviceGenerator.genFile();