Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Typescript][Angular] Fix generated README when using apiModulePrefix #7725

Merged
merged 1 commit into from
Oct 16, 2020
+24 −24
Merged

[Typescript][Angular] Fix generated README when using apiModulePrefix #7725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions modules/openapi-generator/src/main/resources/typescript-angular/README.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ In your Angular project:

```
// without configuring providers
import { ApiModule } from '{{npmName}}';
import { {{apiModuleClassName}} } from '{{npmName}}';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
imports: [
ApiModule,
{{apiModuleClassName}},
// make sure to import the HttpClientModule in the AppModule only,
// see https://github.com/angular/angular/issues/20575
HttpClientModule
Expand All @@ -73,7 +73,7 @@ export class AppModule {}

```
// configuring providers
import { ApiModule, {{configurationClassName}}, {{configurationParametersInterfaceName}} } from '{{npmName}}';
import { {{apiModuleClassName}}, {{configurationClassName}}, {{configurationParametersInterfaceName}} } from '{{npmName}}';

export function apiConfigFactory (): {{configurationClassName}} => {
const params: {{configurationParametersInterfaceName}} = {
Expand All @@ -83,7 +83,7 @@ export function apiConfigFactory (): {{configurationClassName}} => {
}

@NgModule({
imports: [ ApiModule.forRoot(apiConfigFactory) ],
imports: [ {{apiModuleClassName}}.forRoot(apiConfigFactory) ],
declarations: [ AppComponent ],
providers: [],
bootstrap: [ AppComponent ]
Expand All @@ -93,10 +93,10 @@ export class AppModule {}

```
// configuring providers with an authentication service that manages your access tokens
import { ApiModule, {{configurationClassName}} } from '{{npmName}}';
import { {{apiModuleClassName}}, {{configurationClassName}} } from '{{npmName}}';

@NgModule({
imports: [ ApiModule ],
imports: [ {{apiModuleClassName}} ],
declarations: [ AppComponent ],
providers: [
{
Expand Down Expand Up @@ -124,21 +124,21 @@ export class AppComponent {
}
```

Note: The ApiModule is restricted to being instantiated once app wide.
Note: The {{apiModuleClassName}} is restricted to being instantiated once app wide.
This is to ensure that all services are treated as singletons.

#### Using multiple OpenAPI files / APIs / ApiModules
In order to use multiple `ApiModules` generated from different OpenAPI files,
#### Using multiple OpenAPI files / APIs / {{apiModuleClassName}}s
In order to use multiple `{{apiModuleClassName}}s` generated from different OpenAPI files,
you can create an alias name when importing the modules
in order to avoid naming conflicts:
```
import { ApiModule } from 'my-api-path';
import { ApiModule as OtherApiModule } from 'my-other-api-path';
import { {{apiModuleClassName}} } from 'my-api-path';
import { {{apiModuleClassName}} as OtherApiModule } from 'my-other-api-path';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
imports: [
ApiModule,
{{apiModuleClassName}},
OtherApiModule,
// make sure to import the HttpClientModule in the AppModule only,
// see https://github.com/angular/angular/issues/20575
Expand Down
24 changes: 12 additions & 12 deletions ...pescript-angular-v8-provided-in-root/builds/with-prefixed-module-name/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ In your Angular project:

```
// without configuring providers
import { ApiModule } from '@openapitools/typescript-angular-petstore';
import { PetStoreApiModule } from '@openapitools/typescript-angular-petstore';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
imports: [
ApiModule,
PetStoreApiModule,
// make sure to import the HttpClientModule in the AppModule only,
// see https://github.com/angular/angular/issues/20575
HttpClientModule
Expand All @@ -73,7 +73,7 @@ export class AppModule {}

```
// configuring providers
import { ApiModule, PetStoreConfiguration, PetStoreConfigurationParameters } from '@openapitools/typescript-angular-petstore';
import { PetStoreApiModule, PetStoreConfiguration, PetStoreConfigurationParameters } from '@openapitools/typescript-angular-petstore';

export function apiConfigFactory (): PetStoreConfiguration => {
const params: PetStoreConfigurationParameters = {
Expand All @@ -83,7 +83,7 @@ export function apiConfigFactory (): PetStoreConfiguration => {
}

@NgModule({
imports: [ ApiModule.forRoot(apiConfigFactory) ],
imports: [ PetStoreApiModule.forRoot(apiConfigFactory) ],
declarations: [ AppComponent ],
providers: [],
bootstrap: [ AppComponent ]
Expand All @@ -93,10 +93,10 @@ export class AppModule {}

```
// configuring providers with an authentication service that manages your access tokens
import { ApiModule, PetStoreConfiguration } from '@openapitools/typescript-angular-petstore';
import { PetStoreApiModule, PetStoreConfiguration } from '@openapitools/typescript-angular-petstore';

@NgModule({
imports: [ ApiModule ],
imports: [ PetStoreApiModule ],
declarations: [ AppComponent ],
providers: [
{
Expand Down Expand Up @@ -124,21 +124,21 @@ export class AppComponent {
}
```

Note: The ApiModule is restricted to being instantiated once app wide.
Note: The PetStoreApiModule is restricted to being instantiated once app wide.
This is to ensure that all services are treated as singletons.

#### Using multiple OpenAPI files / APIs / ApiModules
In order to use multiple `ApiModules` generated from different OpenAPI files,
#### Using multiple OpenAPI files / APIs / PetStoreApiModules
In order to use multiple `PetStoreApiModules` generated from different OpenAPI files,
you can create an alias name when importing the modules
in order to avoid naming conflicts:
```
import { ApiModule } from 'my-api-path';
import { ApiModule as OtherApiModule } from 'my-other-api-path';
import { PetStoreApiModule } from 'my-api-path';
import { PetStoreApiModule as OtherApiModule } from 'my-other-api-path';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
imports: [
ApiModule,
PetStoreApiModule,
OtherApiModule,
// make sure to import the HttpClientModule in the AppModule only,
// see https://github.com/angular/angular/issues/20575
Expand Down