In your Angular project:
// without configuring providers
import { LssPackerApiModule } from '@veeroute/lss-packer-angular';
import { HttpClientModule } from '@angular/common/http';
@NgModule({
imports: [
LssPackerApiModule,
// make sure to import the HttpClientModule in the AppModule only,
// see https://github.com/angular/angular/issues/20575
HttpClientModule
],
declarations: [ AppComponent ],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {}
// configuring providers
import { LssPackerApiModule, Configuration, ConfigurationParameters } from '@veeroute/lss-packer-angular';
export function apiConfigFactory (): Configuration {
const params: ConfigurationParameters = {
// set configuration parameters here.
}
return new Configuration(params);
}
@NgModule({
imports: [ LssPackerApiModule.forRoot(apiConfigFactory) ],
declarations: [ AppComponent ],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {}
// configuring providers with an authentication service that manages your access tokens
import { LssPackerApiModule, Configuration } from '@veeroute/lss-packer-angular';
@NgModule({
imports: [ LssPackerApiModule ],
declarations: [ AppComponent ],
providers: [
{
provide: Configuration,
useFactory: (authService: AuthService) => new Configuration(
{
basePath: environment.apiUrl,
accessToken: authService.getAccessToken.bind(authService)
}
),
deps: [AuthService],
multi: false
}
],
bootstrap: [ AppComponent ]
})
export class AppModule {}
import { DefaultApi } from '@veeroute/lss-packer-angular';
export class AppComponent {
constructor(private apiGateway: DefaultApi) { }
}
Note: The LssPackerApiModule is restricted to being instantiated once app wide. This is to ensure that all services are treated as singletons.
In order to use multiple LssPackerApiModules
generated from different OpenAPI files,
you can create an alias name when importing the modules
in order to avoid naming conflicts:
import { LssPackerApiModule } from 'my-api-path';
import { LssPackerApiModule as OtherApiModule } from 'my-other-api-path';
import { HttpClientModule } from '@angular/common/http';
@NgModule({
imports: [
LssPackerApiModule,
OtherApiModule,
// make sure to import the HttpClientModule in the AppModule only,
// see https://github.com/angular/angular/issues/20575
HttpClientModule
]
})
export class AppModule {
}
If different than the generated base path, during app bootstrap, you can provide the base path to your service.
import { BASE_PATH } from '@veeroute/lss-packer-angular';
bootstrap(AppComponent, [
{ provide: BASE_PATH, useValue: 'https://your-web-service.com' },
]);
or
import { BASE_PATH } from '@veeroute/lss-packer-angular';
@NgModule({
imports: [],
declarations: [ AppComponent ],
providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
bootstrap: [ AppComponent ]
})
export class AppModule {}
First extend your src/environments/*.ts
files by adding the corresponding base path:
export const environment = {
production: false,
API_BASE_PATH: 'http://127.0.0.1:8080'
};
In the src/app/app.module.ts:
import { BASE_PATH } from '@veeroute/lss-packer-angular';
import { environment } from '../environments/environment';
@NgModule({
declarations: [
AppComponent
],
imports: [ ],
providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
bootstrap: [ AppComponent ]
})
export class AppModule { }