-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(typescript-angular): add support for Angular V18 (#18916)
* feat/typescript-angular/add-v17-support * HTTP_TRANSFER_CACHE_IN_OPTIONS for angular 17 as well * run build scripts again because of angular 17 HTTP_TRANSFER_CACHE_IN_OPTIONS
- Loading branch information
Showing
28 changed files
with
2,728 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| generatorName: typescript-angular | ||
| outputDir: samples/client/petstore/typescript-angular-v18-provided-in-root/builds/default | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/typescript-angular | ||
| additionalProperties: | ||
| ngVersion: 18.0.0 | ||
| supportsES6: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
samples/client/petstore/typescript-angular-v18-provided-in-root/builds/default/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| wwwroot/*.js | ||
| node_modules | ||
| typings | ||
| dist |
23 changes: 23 additions & 0 deletions
23
...petstore/typescript-angular-v18-provided-in-root/builds/default/.openapi-generator-ignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # OpenAPI Generator Ignore | ||
| # Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
|
||
| # Use this file to prevent files from being overwritten by the generator. | ||
| # The patterns follow closely to .gitignore or .dockerignore. | ||
|
|
||
| # As an example, the C# client generator defines ApiClient.cs. | ||
| # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
| #ApiClient.cs | ||
|
|
||
| # You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
| #foo/*/qux | ||
| # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
|
||
| # You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
| #foo/**/qux | ||
| # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
|
||
| # You can also negate patterns with an exclamation (!). | ||
| # For example, you can ignore all files in a docs folder with the file extension .md: | ||
| #docs/*.md | ||
| # Then explicitly reverse the ignore rule for a single file: | ||
| #!docs/README.md |
20 changes: 20 additions & 0 deletions
20
.../petstore/typescript-angular-v18-provided-in-root/builds/default/.openapi-generator/FILES
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| .gitignore | ||
| README.md | ||
| api.module.ts | ||
| api/api.ts | ||
| api/pet.service.ts | ||
| api/store.service.ts | ||
| api/user.service.ts | ||
| configuration.ts | ||
| encoder.ts | ||
| git_push.sh | ||
| index.ts | ||
| model/apiResponse.ts | ||
| model/category.ts | ||
| model/models.ts | ||
| model/order.ts | ||
| model/pet.ts | ||
| model/tag.ts | ||
| model/user.ts | ||
| param.ts | ||
| variables.ts |
1 change: 1 addition & 0 deletions
1
...etstore/typescript-angular-v18-provided-in-root/builds/default/.openapi-generator/VERSION
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 7.7.0-SNAPSHOT |
226 changes: 226 additions & 0 deletions
226
...lient/petstore/typescript-angular-v18-provided-in-root/builds/default/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,226 @@ | ||
| ## @ | ||
|
|
||
| ### Building | ||
|
|
||
| To install the required dependencies and to build the typescript sources run: | ||
| ``` | ||
| npm install | ||
| npm run build | ||
| ``` | ||
|
|
||
| ### publishing | ||
|
|
||
| First build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!) | ||
|
|
||
| ### consuming | ||
|
|
||
| Navigate to the folder of your consuming project and run one of next commands. | ||
|
|
||
| _published:_ | ||
|
|
||
| ``` | ||
| npm install @ --save | ||
| ``` | ||
|
|
||
| _without publishing (not recommended):_ | ||
|
|
||
| ``` | ||
| npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save | ||
| ``` | ||
|
|
||
| _It's important to take the tgz file, otherwise you'll get trouble with links on windows_ | ||
|
|
||
| _using `npm link`:_ | ||
|
|
||
| In PATH_TO_GENERATED_PACKAGE/dist: | ||
| ``` | ||
| npm link | ||
| ``` | ||
|
|
||
| In your project: | ||
| ``` | ||
| npm link | ||
| ``` | ||
|
|
||
| __Note for Windows users:__ The Angular CLI has troubles to use linked npm packages. | ||
| Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround. | ||
| Published packages are not effected by this issue. | ||
|
|
||
|
|
||
| #### General usage | ||
|
|
||
| In your Angular project: | ||
|
|
||
|
|
||
| ``` | ||
| // without configuring providers | ||
| import { ApiModule } from ''; | ||
| import { HttpClientModule } from '@angular/common/http'; | ||
| @NgModule({ | ||
| imports: [ | ||
| ApiModule, | ||
| // 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 { ApiModule, Configuration, ConfigurationParameters } from ''; | ||
| export function apiConfigFactory (): Configuration { | ||
| const params: ConfigurationParameters = { | ||
| // set configuration parameters here. | ||
| } | ||
| return new Configuration(params); | ||
| } | ||
| @NgModule({ | ||
| imports: [ ApiModule.forRoot(apiConfigFactory) ], | ||
| declarations: [ AppComponent ], | ||
| providers: [], | ||
| bootstrap: [ AppComponent ] | ||
| }) | ||
| export class AppModule {} | ||
| ``` | ||
|
|
||
| ``` | ||
| // configuring providers with an authentication service that manages your access tokens | ||
| import { ApiModule, Configuration } from ''; | ||
| @NgModule({ | ||
| imports: [ ApiModule ], | ||
| 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 ''; | ||
| export class AppComponent { | ||
| constructor(private apiGateway: DefaultApi) { } | ||
| } | ||
| ``` | ||
|
|
||
| Note: The ApiModule 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, | ||
| 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 { HttpClientModule } from '@angular/common/http'; | ||
| @NgModule({ | ||
| imports: [ | ||
| ApiModule, | ||
| OtherApiModule, | ||
| // make sure to import the HttpClientModule in the AppModule only, | ||
| // see https://github.com/angular/angular/issues/20575 | ||
| HttpClientModule | ||
| ] | ||
| }) | ||
| export class AppModule { | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| ### Set service base path | ||
| If different than the generated base path, during app bootstrap, you can provide the base path to your service. | ||
|
|
||
| ``` | ||
| import { BASE_PATH } from ''; | ||
| bootstrap(AppComponent, [ | ||
| { provide: BASE_PATH, useValue: 'https://your-web-service.com' }, | ||
| ]); | ||
| ``` | ||
| or | ||
|
|
||
| ``` | ||
| import { BASE_PATH } from ''; | ||
| @NgModule({ | ||
| imports: [], | ||
| declarations: [ AppComponent ], | ||
| providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ], | ||
| bootstrap: [ AppComponent ] | ||
| }) | ||
| export class AppModule {} | ||
| ``` | ||
|
|
||
|
|
||
| #### Using @angular/cli | ||
| 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 ''; | ||
| import { environment } from '../environments/environment'; | ||
| @NgModule({ | ||
| declarations: [ | ||
| AppComponent | ||
| ], | ||
| imports: [ ], | ||
| providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }], | ||
| bootstrap: [ AppComponent ] | ||
| }) | ||
| export class AppModule { } | ||
| ``` | ||
|
|
||
| ### Customizing path parameter encoding | ||
|
|
||
| Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple' | ||
| and Dates for format 'date-time' are encoded correctly. | ||
|
|
||
| Other styles (e.g. "matrix") are not that easy to encode | ||
| and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]). | ||
|
|
||
| To implement your own parameter encoding (or call another library), | ||
| pass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object | ||
| (see [General Usage](#general-usage) above). | ||
|
|
||
| Example value for use in your Configuration-Provider: | ||
| ```typescript | ||
| new Configuration({ | ||
| encodeParam: (param: Param) => myFancyParamEncoder(param), | ||
| }) | ||
| ``` | ||
|
|
||
| [parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations | ||
| [style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values | ||
| [@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander |
Oops, something went wrong.