add possibility to use oneOf in response and body

Manweill · Oct 21, 2024 · fc36241 · fc36241
1 parent e08649e
commit fc36241
Show file tree

Hide file tree

Showing 5 changed files with 107 additions and 13 deletions.
diff --git a/example/oneOf.json b/example/oneOf.json
@@ -0,0 +1,83 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Swagger Petstore - OpenAPI 3.0",
+    "description": "",
+    "version": "1.0.11"
+  },
+  "paths": {
+    "/pet/": {
+      "post": {
+        "operationId": "createPet",
+        "tags": ["test"],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "oneOf": [
+                  {
+                    "$ref": "#/components/schemas/Cat"
+                  },
+                  {
+                    "$ref": "#/components/schemas/Dog"
+                  }
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "$ref": "#/components/schemas/Cat"
+                    },
+                    {
+                      "$ref": "#/components/schemas/Dog"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Dog": {
+        "type": "object",
+        "properties": {
+          "bark": {
+            "type": "boolean"
+          },
+          "breed": {
+            "type": "string",
+            "enum": [
+              "Dingo",
+              "Husky",
+              "Retriever",
+              "Shepherd"
+            ]
+          }
+        }
+      },
+      "Cat": {
+        "type": "object",
+        "properties": {
+          "hunts": {
+            "type": "boolean"
+          },
+          "age": {
+            "type": "integer"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/example/swagger/oneOf.js b/example/swagger/oneOf.js
@@ -0,0 +1,11 @@
+// const { codegen } = require('swagger-axios-codegen')
+const { codegen } = require('../../dist/index.js')
+
+codegen({
+  methodNameMode: 'operationId',
+  source: require('../oneOf.json'),
+  outputDir: '.',
+  fileName: 'oneOf.ts',
+  strictNullChecks: false,
+  modelMode: 'interface'
+})
diff --git a/src/requestCodegen/getRequestBody.ts b/src/requestCodegen/getRequestBody.ts
@@ -30,6 +30,12 @@ export function getRequestBody(requestBody: IRequestBody) {
     } else if (reqBody.schema.$ref) {
       bodyType = refClassName(reqBody.schema.$ref)
       // console.log('propType', refClassName(p.schema.$ref))
+    } else if (reqBody.schema.oneOf?.length > 0) {
+      bodyType = reqBody.schema.oneOf.map((refType) => {
+        const ref = refClassName(refType.$ref);
+        imports.push(ref)
+        return ref;
+      }).join(" | ")
     }
     if (bodyType) {
       imports.push(bodyType)

diff --git a/src/requestCodegen/getResponseType.ts b/src/requestCodegen/getResponseType.ts
@@ -39,14 +39,17 @@ export function getResponseType(reqProps: IRequestMethod, isV3: boolean): { resp
       const refType = refClassName(resSchema.items.$ref)
       isRef = true
       result = refType + '[]'
-    } else {
+    }  else {
       const refType = toBaseType(resSchema.items.type, resSchema.items?.format)
       result = refType + '[]'
     }
   } else if (resSchema.$ref) {
     // 如果是引用对象
     result = refClassName(resSchema.$ref) || 'any'
     isRef = true
+  } else if (resSchema.oneOf) {
+    result = resSchema.oneOf.map((refType) => refClassName(refType.$ref)).join(" | ")
+    isRef = true
   } else {
     result = checkType
     result = toBaseType(result, format)

diff --git a/src/swaggerInterfaces.ts b/src/swaggerInterfaces.ts
@@ -31,21 +31,11 @@ export interface IRequestMethod {
     [key: string]: {
       description: string
       // v2
-      schema: {
-        '$ref': string,
-        'type'?: string,
-        'items'?: IParameterItems,
-        'format'?: string,
-      },
+      schema: Omit<ISchema, "properties">,
       // v3
       content: {
         [key: string]: {
-          schema: {
-            '$ref': string,
-            'type'?: string,
-            'items'?: IParameterItems,
-            'format'?: string,
-          }
+          schema: Omit<ISchema, "properties">
         }
       }
     }
@@ -128,6 +118,7 @@ export interface ISchema {
   'type'?: string
   'items'?: IParameterItems
   'format'?: string,
+  'oneOf'?: { $ref: string }[];
   'properties'?: { [key: string]: IParameterItems }
 }