Как мы можем добавить некоторые пользовательские ошибки (связанный ключ) в документы API с помощью swagger/nestjs?

Question

Я пытаюсь показать ответ об ошибке после успешного ответа в API Docs. например:-

@ApiResponse({status: 401, description: 'invalid_client'}) (работает)

но я хочу указать customCode, например: -

@ApiResponse({статус: 401, **customCode **: 'invalid_token', description: 'invalid_client'})

но я получаю сообщение об ошибке при добавлении customCode:-

ОШИБКА: - Аргумент типа '{ status: number; customCode: строка; описание: строка; }'не может быть назначен параметру типа'ApiResponseOptions'. Литерал объекта может указывать только известные свойства, а customCode не существует в типе ApiResponseOptions.

Я попытался выяснить это по ссылке Nestjs/swagger, но не смог найти ссылку для этой проблемы.

https://docs.nestjs.com/recipes/swagger

Answer 1

Вы получаете эту ошибку, потому что @ApiResponse()декоратор ожидает только определенные свойства, которые вы не можете добавить в этот декоратор customCode. но если вы хотите, вы можете использовать любой customCode вstatus: yourCustomCode это тоже будет работать, или вы можете просто вернуть customCode в ответе API, если это необходимо.