perf: support apifox config branchId, moduleId

Author: rookie-luochao

.changeset/famous-eels-go.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+perf: support apifox config branchId, moduleId

README-en_US.md

@@ -285,6 +285,8 @@ openapi -i ./spec.json -o ./apis
 | exportFormat | string | specify the format of the exported OpenAPI file, can have values such as 'JSON' or 'YAML' | 'JSON' |
 | includeApifoxExtensionProperties | boolean | specify whether to include the OpenAPI specification extension fields `x-apifox` | false |
 | addFoldersToTags | boolean | specify whether to include the directory name of the interface in the tag field | false |
+| branchId | number | branch id | false |
+| moduleId | number | module id | false |
 
 ## JSON Schemas
 

README.md

@@ -287,6 +287,8 @@ openapi --i ./spec.json --o ./apis
 | exportFormat | string | 指定导出的 OpenAPI 文件的格式，可以有值如 'JSON' 或 'YAML' | 'JSON' |
 | includeApifoxExtensionProperties | boolean | 指定是否包含 Apifox 的 OpenAPI 规范扩展字段 `x-apifox` | false |
 | addFoldersToTags | boolean | 指定是否在标签字段中包含接口的目录名称 | false |
+| branchId | number | 分支ID | false |
+| moduleId | number | 模块ID | false |
 
 ## JSON Schemas
 

agents.md

@@ -270,7 +270,9 @@ else if (isNodeProject) {
     local: "zh-CN",
     selectedTags: ["user", "order"],
     oasVersion: "3.0",
-    exportFormat: "JSON"
+    exportFormat: "JSON",
+    branchId: 123, // Optional: branch id
+    moduleId: 456  // Optional: module id
   },
   serversPath: "./src/apis",
   isGenReactQuery: true,

src/type.ts

@@ -132,18 +132,16 @@ export interface APIFoxBody {
   oasVersion?: '2.0' | '3.0' | '3.1';
   exportFormat?: 'JSON' | 'YAML';
   environmentIds?: string[];
+  branchId?: number;
+  moduleId?: number;
 }
 
-export interface GetSchemaByApifoxProps
-  extends Pick<APIFoxBody, 'oasVersion' | 'exportFormat'>,
-    Pick<
-      APIFoxBody['options'],
-      'includeApifoxExtensionProperties' | 'addFoldersToTags'
-    > {
+export type GetSchemaByApifoxProps = {
   projectId: string;
   apifoxToken: string;
   locale?: string;
   apifoxVersion?: string;
   selectedTags?: string[];
   excludedByTags?: string[];
-}
+} & Pick<APIFoxBody, 'oasVersion' | 'exportFormat' | 'branchId' | 'moduleId'> &
+  APIFoxBody['options'];

src/util.ts

@@ -52,6 +52,8 @@ const getSchemaByApifox = async ({
   exportFormat = 'JSON',
   includeApifoxExtensionProperties = false,
   addFoldersToTags = false,
+  branchId,
+  moduleId,
 }: GetSchemaByApifoxProps): Promise<OpenAPI.Document | null> => {
   try {
     const body: APIFoxBody = {
@@ -65,6 +67,15 @@ const getSchemaByApifox = async ({
       oasVersion,
       exportFormat,
     };
+
+    if (branchId !== undefined) {
+      body.branchId = branchId;
+    }
+
+    if (moduleId !== undefined) {
+      body.moduleId = moduleId;
+    }
+
     const tags = !isEmpty(selectedTags) ? selectedTags : '*';
 
     if (tags === '*') {