Angular 10 Swagger Codegen：通用类型 ModuleWithProviders<T> 需要 1 个类型参数

Question

我正在生成https://editor.swagger.io/ Codegen 代理。 它在 Angular 10 中出现以下错误。如何解决？

通用类型“ModuleWithProviders”需要 1 个类型参数。

export class ApiModule {
    public static forRoot(configurationFactory: () => Configuration): ModuleWithProviders {
        return {
            ngModule: ApiModule,
            providers: [ { provide: Configuration, useFactory: configurationFactory } ]
        };
    }

    constructor( @Optional() @SkipSelf() parentModule: ApiModule,
                 @Optional() http: HttpClient) {
        if (parentModule) {
            throw new Error('ApiModule is already loaded. Import in your base AppModule only.');
        }
        if (!http) {
            throw new Error('You need to import the HttpClientModule in your AppModule! \n' +
            'See also https://github.com/angular/angular/issues/20575');
        }
    }
}

Answer 1

这个错误告诉你，ModuleWithProviders 类有 1 个通用参数。所以你应该像ModuleWithProviders<T> 一样使用它，其中 T 是一个类型。

编辑：

类是这样定义的：

interface ModuleWithProviders<T> {
  ngModule: Type<T>
  providers?: Provider[]
}

.

export class ApiModule {
  public static forRoot(configurationFactory: () => Configuration) : ModuleWithProviders<ApiModule> {
    return {
        ngModule: ApiModule,
        providers: [ { provide: Configuration, useFactory: configurationFactory } ]
    };
}

查看资源：

https://angular.io/guide/migration-module-with-providers

Answer 2

我们偶然发现了同样的问题。幸运的是，您可以使用 -t 开关向 swagger-codegen-cli 提供自定义 *.mustache 模板（请参阅 the swagger doc）。

我们改编后的 api.module.mustache 看起来像这样：

import { NgModule, ModuleWithProviders, SkipSelf, Optional } from '@angular/core';
import { Configuration } from './configuration';
{{#useHttpClient}}import { HttpClient } from '@angular/common/http';{{/useHttpClient}}
{{^useHttpClient}}import { Http } from '@angular/http';{{/useHttpClient}}

{{#apiInfo}}
{{#apis}}
import { {{classname}} } from './{{importPath}}';
{{/apis}}
{{/apiInfo}}

@NgModule({
  imports:      [],
  declarations: [],
  exports:      [],
  providers: [
    {{#apiInfo}}{{#apis}}{{classname}}{{#hasMore}},
    {{/hasMore}}{{/apis}}{{/apiInfo}} ]
})
export class ApiModule {
    public static forRoot(configurationFactory: () => Configuration): ModuleWithProviders<ApiModule> {
        return {
            ngModule: ApiModule,
            providers: [ { provide: Configuration, useFactory: configurationFactory } ]
        };
    }

    constructor( @Optional() @SkipSelf() parentModule: ApiModule,
                 @Optional() http: {{#useHttpClient}}HttpClient{{/useHttpClient}}{{^useHttpClient}}Http{{/useHttpClient}}) {
        if (parentModule) {
            throw new Error('ApiModule is already loaded. Import in your base AppModule only.');
        }
        if (!http) {
            throw new Error('You need to import the {{#useHttpClient}}HttpClientModule{{/useHttpClient}}{{^useHttpClient}}HttpModule{{/useHttpClient}} in your AppModule! \n' +
            'See also https://github.com/angular/angular/issues/20575');
        }
    }
}

唯一需要的更改是将ModuleWithProviders 替换为ModuleWithProviders<ApiModule>。 之后生成的 api.module.ts 将适用于 Angular 10。

Answer 3

io.swagger.swagger-codegen 自版本 2.4.17 起完全支持 Angular 10。您可以详细了解此pull request 中提供的修复程序。

正如djf 提到的，在调用generate 时使用参数--additional-properties ngVersion=10 来告诉io.swagger.swagger-codegen 使用Angular 10。