Method exploreController

lib/swagger-explorer.ts:104–156

(
    wrapper: InstanceWrapper<Controller>,
    applicationConfig: ApplicationConfig,
    options: {
      modulePath?: string;
      globalPrefix?: string;
      operationIdFactory?: OperationIdFactory;
      linkNameFactory?: (
        controllerKey: string,
        methodKey: string,
        fieldKey: string
      ) => string;
      autoTagControllers?: boolean;
      onlyIncludeDecoratedEndpoints?: boolean;
    }
  )

  ) {}

  public exploreController(
    wrapper: InstanceWrapper<Controller>,
    applicationConfig: ApplicationConfig,
    options: {
      modulePath?: string;
      globalPrefix?: string;
      operationIdFactory?: OperationIdFactory;
      linkNameFactory?: (
        controllerKey: string,
        methodKey: string,
        fieldKey: string
      ) => string;
      autoTagControllers?: boolean;
      onlyIncludeDecoratedEndpoints?: boolean;
    }
  ) {
    const { operationIdFactory, linkNameFactory } = options;

    this.routePathFactory = new RoutePathFactory(applicationConfig);
    if (operationIdFactory) {
      this.operationIdFactory = operationIdFactory;
    }

    if (linkNameFactory) {
      this.linkNameFactory = linkNameFactory;
    }
    const { instance, metatype } = wrapper;
    const prototype = Object.getPrototypeOf(instance);
    const documentResolvers: DenormalizedDocResolvers = {
      root: [
        this.exploreRoutePathAndMethod,
        exploreApiOperationMetadata,
        exploreApiParametersMetadata.bind(null, this.schemas)
      ],
      security: [exploreApiSecurityMetadata],
      tags: [exploreApiTagsMetadata],
      callbacks: [exploreApiCallbacksMetadata],
      responses: [
        exploreApiResponseMetadata.bind(null, this.schemas, {
          operationId: this.operationIdFactory,
          linkName: this.linkNameFactory
        })
      ]
    };
    return this.generateDenormalizedDocument(
      metatype as Type<unknown>,
      prototype,
      instance,
      documentResolvers,
      applicationConfig,
      options
    );
  }

  public getSchemas(): Record<string, SchemaObject> {
    return this.schemas;