Merge pull request #266 from openapi-ui/main

feat: support extra apifox config

Author: rookie-luochao

.changeset/clean-garlics-tan.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+feat: support extra apifox config

pnpm-lock.yaml

@@ -120,24 +120,30 @@ export type ReadConfigOptions = MutuallyExclusiveWithFallback<
 > & { fallbackName: string };
 
 export interface APIFoxBody {
-  scope: {
+  scope?: {
     type?: 'ALL' | 'SELECTED_TAGS';
     includeTags?: string[];
     excludeTags?: string[];
   };
   options?: {
-    includeApifoxExtensionProperties: boolean;
-    addFoldersToTags: boolean;
+    includeApifoxExtensionProperties?: boolean;
+    addFoldersToTags?: boolean;
   };
   oasVersion?: '2.0' | '3.0' | '3.1';
   exportFormat?: 'JSON' | 'YAML';
   environmentIds?: string[];
 }
-export interface GetSchemaByApifoxProps {
+
+export interface GetSchemaByApifoxProps
+  extends Pick<APIFoxBody, 'oasVersion' | 'exportFormat'>,
+    Pick<
+      APIFoxBody['options'],
+      'includeApifoxExtensionProperties' | 'addFoldersToTags'
+    > {
   projectId: string;
+  apifoxToken: string;
   locale?: string;
   apifoxVersion?: string;
   includeTags?: (string | RegExp)[];
   excludeTags?: string[];
-  apifoxToken: string;
 }

src/type.ts

@@ -79,18 +79,22 @@ const getSchemaByApifox = async ({
   includeTags,
   excludeTags = [],
   apifoxToken,
+  oasVersion = '3.0',
+  exportFormat = 'JSON',
+  includeApifoxExtensionProperties = false,
+  addFoldersToTags = false,
 }: GetSchemaByApifoxProps): Promise<OpenAPI.Document | null> => {
   try {
     const body: APIFoxBody = {
       scope: {
         excludeTags,
       },
       options: {
-        includeApifoxExtensionProperties: false,
-        addFoldersToTags: false,
+        includeApifoxExtensionProperties,
+        addFoldersToTags,
       },
-      oasVersion: '3.0',
-      exportFormat: 'JSON',
+      oasVersion,
+      exportFormat,
     };
     const tags = getApifoxIncludeTags(includeTags);
 
@@ -103,7 +107,7 @@ const getSchemaByApifox = async ({
 
     const res = await axios.post(
       `https://api.apifox.com/v1/projects/${projectId}/export-openapi?locale=${locale}`,
-      {},
+      body,
       {
         headers: {
           'X-Apifox-Api-Version': apifoxVersion,