Nestjs + Swagger: How to add a custom option to @ApiProperty

Question

Is it possible to add a custom option to @ApiProperty decorator?

import { ApiProperty } from '@nestjs/swagger';

class Animal {

  @ApiProperty({
    type: String,
    description: 'animal name',
    'x-description': 'some information' // how to add a cutom option 'x-description' ?
  })
  name: string;
}

@EmptyBrain I can't see anything about a custom option there. — KDI
– KDI, Commented May 22, 2022 at 16:24

CY-OD · Accepted Answer · 2022-05-22 11:56:06Z

1

I'm not sure i fully understand, but If you are talking about openapi's extensions. Take a look at this: https://github.com/nestjs/swagger/issues/195

answered May 22, 2022 at 11:56

CY-OD

4711 gold badge4 silver badges10 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

KDI Over a year ago

I don't catch how to use Extension decorator to add a custom attribute. I've created a custom decorator than extends ApiProperty like github.com/nestjs/swagger/issues/195#issuecomment-526215840 and it works well.

CY-OD Over a year ago

not sure i fully understand what you mean.

KDI · Accepted Answer · 2022-05-28 10:24:24Z

1

Solution from https://github.com/nestjs/swagger/issues/195#issuecomment-526215840

import { ApiProperty } from '@nestjs/swagger';

type SwaggerDecoratorParams = Parameters<typeof ApiProperty>;
type SwaggerDecoratorMetadata = SwaggerDecoratorParams[0];
type Options = SwaggerDecoratorMetadata & DictionarySwaggerParameters;
type DictionarySwaggerParameters = { 'x-property'?: string };

export const ApiPropertyX = (params: Options) => {
  return ApiProperty(params);
};

answered May 28, 2022 at 10:24

KDI

911 silver badge8 bronze badges

Collectives™ on Stack Overflow

Nestjs + Swagger: How to add a custom option to @ApiProperty

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related