fix(plugin): allow the use of "uiConfig" options to fastify-swagger and Swagger UI

[lazharichir]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[X] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

Using @nestjs/swagger with Fastify, you cannot pass the uiConfig options at fastify-swagger plugin registration.

Issue Number: N/A

What is the new behavior?

You can pass on uiConfig as per fastify-swagger's documentation.

Does this PR introduce a breaking change?

[ ] Yes
[X] No

Other information

In order to get there, this PR adds a fourth argument to setupFastify() which is the options: SwaggerCustomOptions object. This PR also adds the uiConfig?: Record<string, any> property to SwaggerCustomOptions as hint.

With this update, we can make use of great features from Swagger UI such as authorization persistence (uiConfig.persistAuthorization) and showing the operation's id (uiConfig.displayOperationId).

[kamilmysliwiec]

We should define a separate options object for the fastify platform.

[lazharichir]

With just the uiConfig property (for now)?

export interface FastifySwaggerCustomOptions {
  uiConfig?: Record<string, any>;
}

And how do you want to handle narrowing the options type since we would have to do something along the lines of SwaggerCustomOptions | FastifySwaggerCustomOptions:

  public static setup(
    path: string,
    app: INestApplication,
    document: OpenAPIObject,
    options?: SwaggerCustomOptions | FastifySwaggerCustomOptions
  ) {
    const httpAdapter = app.getHttpAdapter();
    if (httpAdapter && httpAdapter.getType() === 'fastify') {
      return this.setupFastify(
        path,
        httpAdapter,
        document,
        options as FastifySwaggerCustomOptions
      );
    }
    return this.setupExpress(
      path,
      app,
      document,
      options as SwaggerCustomOptions
    );
  }

[kamilmysliwiec]

Sounds good! Since we're about to introduce a new FastifySwaggerCustomOptions type, I think we should rename the existing one (SwaggerCustomOptions) to ExpressSwaggerCustomOptions and define a union type SwaggerCustomOptions = ExpressSwaggerCustomOptions | FastifySwaggerCustomOptions

[lazharichir]

@kamilmysliwiec sorry, had a lot on my plate but I've done the split! :)

[kamilmysliwiec]

LGTM. Merged to 8.0.0 branch