Skip to content

feat(typescript-angular): add util "provideApi" and update docs to standalone applications #21173

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

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(typescript-angular): add util "provideApi" and update docs to standalone applications #21173

wants to merge 3 commits into from
+1,516 −2,366

Conversation

jase88
Copy link
Contributor

@jase88 jase88 commented Apr 28, 2025 •
edited
Loading

  • Added a new utility provideApi for standalone Angular applications (introduced in Angular v17 and now the default for new projects).
    • This utility is only generated for projects using Angular v17 or higher.
  • Updated documentation to focus on the new default approach for standalone Angular applications.
    • The updated documentation also applies to projects using Angular versions lower than 17 to avoid maintaining separate READMEs.

fixes #20884

relates #17031

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jase88 jase88 mentioned this pull request Apr 28, 2025
Open
@jase88
Copy link
Contributor Author

jase88 commented May 5, 2025

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)

Would be great to get a review / feedback

macjohnny
macjohnny reviewed May 17, 2025
View reviewed changes
Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks a lot for your contribution, looks good!
please address the comments, then we can merge it.

modules/openapi-generator/src/main/resources/typescript-angular/README.mustache
```
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '{{npmName}}';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would suggest to also generate the readme dependent on the ng version, so it is still correct for ng < 16 users

modules/openapi-generator/src/main/resources/typescript-angular/provide-api.mustache
import { {{configurationClassName}}, {{configurationParametersInterfaceName}} } from './configuration';
import { BASE_PATH } from './variables';

export function provideApi(configOrBasePath: string | {{configurationParametersInterfaceName}}) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about adding a comment here like // Returns the service class providers, to be used in the [ApplicationConfig](https://angular.dev/api/core/ApplicationConfig).

modules/openapi-generator/src/main/resources/typescript-angular/provide-api.mustache
import { {{configurationClassName}}, {{configurationParametersInterfaceName}} } from './configuration';
import { BASE_PATH } from './variables';

export function provideApi(configOrBasePath: string | {{configurationParametersInterfaceName}}) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add the return type EnvironmentProviders;

@macjohnny
Copy link
Member

@jase88 sorry for the long delay with the review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@macjohnny macjohnny macjohnny left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@jase88 @macjohnny