|
| 1 | +## @ |
| 2 | + |
| 3 | +### Building |
| 4 | + |
| 5 | +To install the required dependencies and to build the typescript sources run: |
| 6 | +``` |
| 7 | +npm install |
| 8 | +npm run build |
| 9 | +``` |
| 10 | + |
| 11 | +### publishing |
| 12 | + |
| 13 | +First build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!) |
| 14 | + |
| 15 | +### consuming |
| 16 | + |
| 17 | +Navigate to the folder of your consuming project and run one of next commands. |
| 18 | + |
| 19 | +_published:_ |
| 20 | + |
| 21 | +``` |
| 22 | +npm install @ --save |
| 23 | +``` |
| 24 | + |
| 25 | +_without publishing (not recommended):_ |
| 26 | + |
| 27 | +``` |
| 28 | +npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save |
| 29 | +``` |
| 30 | + |
| 31 | +_It's important to take the tgz file, otherwise you'll get trouble with links on windows_ |
| 32 | + |
| 33 | +_using `npm link`:_ |
| 34 | + |
| 35 | +In PATH_TO_GENERATED_PACKAGE/dist: |
| 36 | +``` |
| 37 | +npm link |
| 38 | +``` |
| 39 | + |
| 40 | +In your project: |
| 41 | +``` |
| 42 | +npm link |
| 43 | +``` |
| 44 | + |
| 45 | +__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages. |
| 46 | +Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround. |
| 47 | +Published packages are not effected by this issue. |
| 48 | + |
| 49 | + |
| 50 | +#### General usage |
| 51 | + |
| 52 | +In your Angular project: |
| 53 | + |
| 54 | + |
| 55 | +``` |
| 56 | +// without configuring providers |
| 57 | +import { ApiModule } from ''; |
| 58 | +import { HttpClientModule } from '@angular/common/http'; |
| 59 | +
|
| 60 | +@NgModule({ |
| 61 | + imports: [ |
| 62 | + ApiModule, |
| 63 | + // make sure to import the HttpClientModule in the AppModule only, |
| 64 | + // see https://github.com/angular/angular/issues/20575 |
| 65 | + HttpClientModule |
| 66 | + ], |
| 67 | + declarations: [ AppComponent ], |
| 68 | + providers: [], |
| 69 | + bootstrap: [ AppComponent ] |
| 70 | +}) |
| 71 | +export class AppModule {} |
| 72 | +``` |
| 73 | + |
| 74 | +``` |
| 75 | +// configuring providers |
| 76 | +import { ApiModule, Configuration, ConfigurationParameters } from ''; |
| 77 | +
|
| 78 | +export function apiConfigFactory (): Configuration => { |
| 79 | + const params: ConfigurationParameters = { |
| 80 | + // set configuration parameters here. |
| 81 | + } |
| 82 | + return new Configuration(params); |
| 83 | +} |
| 84 | +
|
| 85 | +@NgModule({ |
| 86 | + imports: [ ApiModule.forRoot(apiConfigFactory) ], |
| 87 | + declarations: [ AppComponent ], |
| 88 | + providers: [], |
| 89 | + bootstrap: [ AppComponent ] |
| 90 | +}) |
| 91 | +export class AppModule {} |
| 92 | +``` |
| 93 | + |
| 94 | +``` |
| 95 | +// configuring providers with an authentication service that manages your access tokens |
| 96 | +import { ApiModule, Configuration } from ''; |
| 97 | +
|
| 98 | +@NgModule({ |
| 99 | + imports: [ ApiModule ], |
| 100 | + declarations: [ AppComponent ], |
| 101 | + providers: [ |
| 102 | + { |
| 103 | + provide: Configuration, |
| 104 | + useFactory: (authService: AuthService) => new Configuration( |
| 105 | + { |
| 106 | + basePath: environment.apiUrl, |
| 107 | + accessToken: authService.getAccessToken.bind(authService) |
| 108 | + } |
| 109 | + ), |
| 110 | + deps: [AuthService], |
| 111 | + multi: false |
| 112 | + } |
| 113 | + ], |
| 114 | + bootstrap: [ AppComponent ] |
| 115 | +}) |
| 116 | +export class AppModule {} |
| 117 | +``` |
| 118 | + |
| 119 | +``` |
| 120 | +import { DefaultApi } from ''; |
| 121 | +
|
| 122 | +export class AppComponent { |
| 123 | + constructor(private apiGateway: DefaultApi) { } |
| 124 | +} |
| 125 | +``` |
| 126 | + |
| 127 | +Note: The ApiModule is restricted to being instantiated once app wide. |
| 128 | +This is to ensure that all services are treated as singletons. |
| 129 | + |
| 130 | +#### Using multiple OpenAPI files / APIs / ApiModules |
| 131 | +In order to use multiple `ApiModules` generated from different OpenAPI files, |
| 132 | +you can create an alias name when importing the modules |
| 133 | +in order to avoid naming conflicts: |
| 134 | +``` |
| 135 | +import { ApiModule } from 'my-api-path'; |
| 136 | +import { ApiModule as OtherApiModule } from 'my-other-api-path'; |
| 137 | +import { HttpClientModule } from '@angular/common/http'; |
| 138 | +
|
| 139 | +@NgModule({ |
| 140 | + imports: [ |
| 141 | + ApiModule, |
| 142 | + OtherApiModule, |
| 143 | + // make sure to import the HttpClientModule in the AppModule only, |
| 144 | + // see https://github.com/angular/angular/issues/20575 |
| 145 | + HttpClientModule |
| 146 | + ] |
| 147 | +}) |
| 148 | +export class AppModule { |
| 149 | +
|
| 150 | +} |
| 151 | +``` |
| 152 | + |
| 153 | + |
| 154 | +### Set service base path |
| 155 | +If different than the generated base path, during app bootstrap, you can provide the base path to your service. |
| 156 | + |
| 157 | +``` |
| 158 | +import { BASE_PATH } from ''; |
| 159 | +
|
| 160 | +bootstrap(AppComponent, [ |
| 161 | + { provide: BASE_PATH, useValue: 'https://your-web-service.com' }, |
| 162 | +]); |
| 163 | +``` |
| 164 | +or |
| 165 | + |
| 166 | +``` |
| 167 | +import { BASE_PATH } from ''; |
| 168 | +
|
| 169 | +@NgModule({ |
| 170 | + imports: [], |
| 171 | + declarations: [ AppComponent ], |
| 172 | + providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ], |
| 173 | + bootstrap: [ AppComponent ] |
| 174 | +}) |
| 175 | +export class AppModule {} |
| 176 | +``` |
| 177 | + |
| 178 | + |
| 179 | +#### Using @angular/cli |
| 180 | +First extend your `src/environments/*.ts` files by adding the corresponding base path: |
| 181 | + |
| 182 | +``` |
| 183 | +export const environment = { |
| 184 | + production: false, |
| 185 | + API_BASE_PATH: 'http://127.0.0.1:8080' |
| 186 | +}; |
| 187 | +``` |
| 188 | + |
| 189 | +In the src/app/app.module.ts: |
| 190 | +``` |
| 191 | +import { BASE_PATH } from ''; |
| 192 | +import { environment } from '../environments/environment'; |
| 193 | +
|
| 194 | +@NgModule({ |
| 195 | + declarations: [ |
| 196 | + AppComponent |
| 197 | + ], |
| 198 | + imports: [ ], |
| 199 | + providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }], |
| 200 | + bootstrap: [ AppComponent ] |
| 201 | +}) |
| 202 | +export class AppModule { } |
| 203 | +``` |
0 commit comments