perf: support schemas array[enum]

Author: rookie-luochao

.changeset/odd-fireants-tell.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+perf: support schemas array[enum]

src/generator/serviceGenarator.ts

@@ -328,7 +328,7 @@ export default class ServiceGenerator {
           });
         });
 
-        const typeName = this.getTypeName({
+        const typeName = this.getFunctionParamsTypeName({
           ...operationObject,
           method,
           path: pathKey,
@@ -350,6 +350,7 @@ export default class ServiceGenerator {
       const result = this.resolveObject(schema) as Dictionary<
         string | boolean | IPropObject[][]
       >;
+      console.log('result: ', result);
 
       const getDefinesType = (): string => {
         if (result?.type) {
@@ -541,7 +542,7 @@ export default class ServiceGenerator {
                 functionName: this.config.isCamelCase
                   ? camelCase(functionName)
                   : functionName,
-                typeName: this.getTypeName(newApi),
+                typeName: this.getFunctionParamsTypeName(newApi),
                 path: getPrefixPath(),
                 pathInComment: formattedPath.replace(/\*/g, '&#42;'),
                 apifoxRunLink: newApi?.['x-run-in-apifox'],
@@ -666,7 +667,7 @@ export default class ServiceGenerator {
     return getDefaultType(schemaObject, namespace, schemas);
   }
 
-  private getTypeName(data: APIDataType) {
+  private getFunctionParamsTypeName(data: APIDataType) {
     const namespace = this.config.namespace ? `${this.config.namespace}.` : '';
     const typeName =
       this.config?.hook?.customTypeName?.(data) || this.getFunctionName(data);
@@ -946,6 +947,10 @@ export default class ServiceGenerator {
       return {
         type: `${refName}[]`,
       };
+    } else if (schemaObject.items?.enum) {
+      return {
+        type: this.getType(schemaObject, this.config.namespace),
+      };
     }
 
     // 这里需要解析出具体属性，但由于 parser 层还不确定，所以暂时先返回 unknown[]

test/example-files/openapi-schemas-enum-array.json

@@ -0,0 +1,81 @@
+{
+  "openapi": "3.0.2",
+  "info": {
+    "title": "Swagger Petstore - OpenAPI 3.0",
+    "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)",
+    "termsOfService": "http://swagger.io/terms/",
+    "contact": {
+      "email": "apiteam@swagger.io"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+    },
+    "version": "1.0.19"
+  },
+  "externalDocs": {
+    "description": "Find out more about Swagger",
+    "url": "http://swagger.io"
+  },
+  "servers": [
+    {
+      "url": "/api/v3"
+    }
+  ],
+  "tags": [
+    {
+      "name": "user",
+      "description": "Operations about user"
+    }
+  ],
+  "paths": {
+    "/user/{username}": {
+      "delete": {
+        "tags": ["user"],
+        "summary": "Delete user",
+        "description": "This can only be done by the logged in user.",
+        "operationId": "deleteUser",
+        "parameters": [
+          {
+            "name": "username",
+            "in": "path",
+            "description": "The name that needs to be deleted",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "status",
+            "in": "query",
+            "description": "The status that needs to be deleted",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/StatusEnumArray"
+            }
+          }
+        ],
+        "responses": {
+          "400": {
+            "description": "Invalid username supplied"
+          },
+          "404": {
+            "description": "User not found"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "StatusEnumArray": {
+        "type": "array",
+        "items": {
+          "type": "string",
+          "enum": ["value1", "value2", "value3"]
+        },
+        "description": "An array of enumerated strings"
+      }
+    }
+  }
+}

test/genOpenapi.js

@@ -1,7 +1,6 @@
 const { generateService } = require('../dist/index');
 
 generateService({
-  schemaPath: `${__dirname}/example-files/openapi-ref-encode-character.json`,
-  serversPath: './apis/ref-encode-character',
-  isTranslateToEnglishTag: true
+  schemaPath: `${__dirname}/example-files/openapi-schemas-enum-array.json`,
+  serversPath: './apis/schemas-enum-array',
 });

test/test.js

@@ -152,6 +152,12 @@ const gen = async () => {
     serversPath: './apis/x-run-in-apifox'
   });
 
+  // 测试 schemas 包含枚举数组
+  await openAPI.generateService({
+    schemaPath: `${__dirname}/example-files/openapi-schemas-enum-array.json`,
+    serversPath: './apis/schemas-enum-array'
+  });
+
   // check 文件生成
   const fileControllerStr = fs.readFileSync(
     path.join(__dirname, 'apis/file/fileController.ts'),