Utilize the nests cli swagger plugin to enable compatibility with external models

Question

Utilize the nests cli swagger plugin to enable compatibility with external models

Exploring the functionality of the swagger plugin provided by nestjs, I am eager to try it out.

While it works smoothly when defining a class like CreateUserDto, my goal is to incorporate types from a third-party library - specifically @adyen/api-library. This library includes classes such as Notification and NotificationResponse, which I would like to use as my request/response dtos. Is this possible with the swagger plugin?

In attempting to inherit from these classes, I created the following:

export class AdyenNotificationDto extends Notification {}

This was saved in

adyen-notification.request.dto.ts

, however, it did not yield the desired results.

If integrating with the third-party library is not feasible, does this mean that I will have to resort to duplication? In other words, would I need to manually create a dto containing all properties from the Notification class and ensure they are kept in sync moving forward?

typescript nestjs

Answer 1

Answer №1

In order to incorporate an external package with the swagger plugin, you must compile it using the nest build command. This is necessary because during the compilation process, Nest examines the AST of the classes and applies the appropriate decorators before initiating the tsc process. If you simply try to integrate the pre-built package into your application without compiling it first, there will be no AST to analyze and decorate, resulting in the inability to apply decorators to an already compiled package.

Answer 2

In order to incorporate an external package with the swagger plugin, you must compile it using the nest build command. This is necessary because during the compilation process, Nest examines the AST of the classes and applies the appropriate decorators before initiating the tsc process. If you simply try to integrate the pre-built package into your application without compiling it first, there will be no AST to analyze and decorate, resulting in the inability to apply decorators to an already compiled package.

Utilize the nests cli swagger plugin to enable compatibility with external models

Answer №1

Similar questions

Mistakes following update to Angular 4 from Angular 2

The specified type does not meet the constraint as it lacks the required index signature

Dynamic Data Binding in Ionic 2

Encountering ERR_INVALID_HTTP_RESPONSE when trying to establish a connection with a Python gRPC server using @bufbuild/connect

Is there a way to pass around jest mocks across numerous tests?

TypeScript: When using an API, it consistently returns an empty object with the type { [key: string]: any }

I require clarity on this befuddling syntax that feels like descending into

Declaring properties for an interface

Ensure to pass the correct type to the useState function

The issue encountered is when the data from the Angular form in the login.component.html file fails to be

Specify the dependencies in the package.json file to ensure that the React package designed for React v17 is compatible with React v18 as well

Steps for incorporating jQuery files into Angular 4

Having trouble uploading an image using Angular, encountering an error in the process

Eliminate spacing in MaterialUi grids

The ng2-intl encounters an issue when trying to resolve symbol values statically

After introducing 5 guard properties, the intersection of unions in Typescript breaks down

The correct way to type a generic React function component using TypeScript

Issues with NextJS detecting environmental variables

Setting up next-i18next with NextJS and Typescript

Make TextField with type number forcibly show dot as decimal separator