fix(migrations): 修复 OpenAPI 2.0 迁移到 3.0 时 body 参数的处理

- 优化参数迁移逻辑，确保 body 参数正确迁移到 query 参数或 requestBody
- 修复 delete、patch、post 和 put 方法中 body 参数的处理
- 添加测试用例验证 get 和 post 方法中 body 参数的迁移

Author: cloudcome

src/migrations/openapi-2_0.ts

@@ -132,10 +132,10 @@ function migGeneralParameter(parameter: OpenAPIV2.GeneralParameterObject | OpenA
   }
 
   const { $ref, in: in_, name, required, description, ...schema } = parameter;
-  const inQuery = in_ === 'query';
+  const inV3 = in_ === 'cookie' || in_ === 'header' || in_ === 'path' ? in_ : 'query';
+  const inQuery = inV3 === 'query';
   const style = inQuery ? collectionFormatMap[parameter.collectionFormat || 'csv'] : undefined;
   const explode = inQuery ? explodeMap[parameter.collectionFormat || 'csv'] : undefined;
-  const inV3 = in_ === 'cookie' || in_ === 'header' || in_ === 'path' ? in_ : 'query';
 
   return {
     in: inV3,
@@ -150,15 +150,8 @@ function migGeneralParameter(parameter: OpenAPIV2.GeneralParameterObject | OpenA
 
 function makeRequestBody(bodySchema: BodySchema[], medias: string[]): OpenAPIV3.RequestBodyObject {
   let requestBodySchema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | undefined;
-  const bodyRequest = bodySchema.find(({ parameter }) => parameter.in === 'body');
-  const requestBodyRest = {};
 
-  if (bodyRequest) {
-    requestBodySchema = bodyRequest.schema;
-    const { required, description } = bodyRequest.parameter;
-    Object.assign(requestBodyRest, { required, description });
-  }
-  else if (bodySchema.length > 0) {
+  if (bodySchema.length > 0) {
     requestBodySchema = {
       type: 'object',
       properties: bodySchema.reduce(
@@ -178,7 +171,6 @@ function makeRequestBody(bodySchema: BodySchema[], medias: string[]): OpenAPIV3.
   }
 
   return {
-    ...requestBodyRest,
     content: requestBodySchema
       ? medias.reduce(
           (content, media) => {
@@ -196,13 +188,13 @@ interface BodySchema {
   parameter: OpenAPIV2.Parameter;
   schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject;
 }
-function migOperation(operation: OpenAPIV2.OperationObject): OpenAPIV3.OperationObject {
+function migOperation(operation: OpenAPIV2.OperationObject, migBody = false): OpenAPIV3.OperationObject {
   const { parameters, responses, consumes, produces, ...rest } = operation;
   const generalParameters: (OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject)[] = [];
   const inBodySchemas: BodySchema[] = [];
 
   parameters?.forEach((parameter) => {
-    if ('in' in parameter && bodyIns.includes(parameter.in)) {
+    if (migBody && 'in' in parameter && bodyIns.includes(parameter.in)) {
       const schema = extractParameterSchema(parameter);
       inBodySchemas.push({
         parameter,
@@ -233,12 +225,12 @@ function migPathItem(pathItem: OpenAPIV2.PathItemObject | undefined): OpenAPIV3.
     // 忽略
     // parameters: parameters && parameters.map(migParameter),
     get: get && migOperation(get),
-    delete: delete_ && migOperation(delete_),
+    delete: delete_ && migOperation(delete_, true),
     head: head && migOperation(head),
     options: options && migOperation(options),
-    patch: patch && migOperation(patch),
-    post: post && migOperation(post),
-    put: put && migOperation(put),
+    patch: patch && migOperation(patch, true),
+    post: post && migOperation(post, true),
+    put: put && migOperation(put, true),
   };
 }
 

test/migrations/openapi_2_0.test.ts

@@ -92,3 +92,128 @@ it('pet store', () => {
   // console.log(JSON.stringify(v3));
   expect(v3).toEqual(petStore3);
 });
+
+it('get parameter in=body', () => {
+  const v2: OpenAPIV2.Document = {
+    swagger: '2.0',
+    info: {
+      title: 'test',
+      version: '1.0.0',
+    },
+    paths: {
+      '/test': {
+        get: {
+          parameters: [
+            {
+              in: 'body',
+              name: 'botId',
+              description: 'botId',
+              required: false,
+              schema: {
+                type: 'integer',
+                format: 'int64',
+              },
+            },
+          ],
+          responses: {
+            200: {
+              description: 'test',
+            },
+          },
+        },
+      },
+    },
+  };
+  const v3 = migrate_2_0To3_0(v2);
+
+  // console.log(JSON.stringify(v3));
+  expect(v3).toEqual<OpenAPIV3.Document>({
+    openapi: '3.0.3',
+    info: { title: 'test', version: '1.0.0' },
+    paths: {
+      '/test': {
+        get: {
+          parameters: [
+            {
+              in: 'query',
+              name: 'botId',
+              required: false,
+              description: 'botId',
+              schema: { type: 'integer', format: 'int64' },
+              style: 'form',
+              explode: false,
+            },
+          ],
+          requestBody: { content: {} },
+          responses: { 200: { description: 'test', content: {} } },
+        },
+      },
+    },
+    components: {},
+  });
+});
+
+it('post parameter in=body', () => {
+  const v2: OpenAPIV2.Document = {
+    swagger: '2.0',
+    info: {
+      title: 'test',
+      version: '1.0.0',
+    },
+    paths: {
+      '/test': {
+        post: {
+          parameters: [
+            {
+              in: 'body',
+              name: 'botId',
+              description: 'botId',
+              required: false,
+              schema: {
+                type: 'integer',
+                format: 'int64',
+              },
+            },
+          ],
+          responses: {
+            200: {
+              description: 'test',
+            },
+          },
+        },
+      },
+    },
+  };
+  const v3 = migrate_2_0To3_0(v2);
+
+  // console.log(JSON.stringify(v3));
+  expect(v3).toEqual<OpenAPIV3.Document>({
+    openapi: '3.0.3',
+    info: { title: 'test', version: '1.0.0' },
+    paths: {
+      '/test': {
+        post: {
+          requestBody: {
+            content: {
+              '*': {
+                schema: {
+                  type: 'object',
+                  properties: {
+                    botId: {
+                      required: false,
+                      description: 'botId',
+                      type: 'integer',
+                      format: 'int64',
+                    },
+                  },
+                },
+              },
+            },
+          },
+          responses: { 200: { description: 'test', content: {} } },
+        },
+      },
+    },
+    components: {},
+  });
+});