fix(swagger): fix the parsing of enum types with array (midwayjs#4083)

7kyun · Sep 29, 2024 · dc2a74d · dc2a74d
1 parent eaa292a
commit dc2a74d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/packages/swagger/src/decorators/api-property.decorator.ts b/packages/swagger/src/decorators/api-property.decorator.ts
@@ -45,7 +45,7 @@ export function createApiPropertyDecorator(
  options.type = getEnumType(enumValues);
  }
 
- if (isArray) {
+ if (options.type !== 'array' && isArray) {
  options.type = 'array';
  options.items = {
  type: type as any,

diff --git a/packages/swagger/test/parser.test.ts b/packages/swagger/test/parser.test.ts
@@ -2208,6 +2208,26 @@ describe('test property metadata parse', () => {
  additionalProperties: true
  });
  });
+
+ it('should format enum type with array', () => {
+ enum Animal {
+ Cat = 0,
+ Dog = 1,
+ Pig = 2,
+ }
+
+ const result = swaggerExplorer.formatType({
+ type: 'enum',
+ enum: Animal,
+ isArray: true,
+ });
+
+ expect(result).toEqual({
+ type: 'enum',
+ isArray: true,
+ enum: [0, 1, 2],
+ });
+ })
 });
 
 describe('test @ApiOperation', () => {