Skip to content

Conversation

@gonzalad
Copy link
Contributor

@gonzalad gonzalad commented Dec 12, 2025

This PR adds support for Angular’s experimental httpResource API (see issue #21263).

Support is currently limited to GET requests, following Angular’s official recommendation:

TIP: Avoid using httpResource for mutations like POST or PUT.
Instead, prefer directly using the underlying HttpClient APIs.

All non-GET methods continue to rely on RxJS.

Tests

A new integration test was introduced:
TypescriptAngularResourceIntegrationTest.

As with the other TypeScript integration tests, it is currently disabled in the pushed version.

Generated API (example)

Parameters accept either signal or non-signal types, enabling flexible usage depending on the consumer’s needs.

Single GET example:

public lireEntreprise(id: Signal<string> | string, reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<Entreprise>;
public lireEntreprise(id: Signal<string> | string, reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<HttpResponse<Entreprise>>;
public lireEntreprise(id: Signal<string> | string, reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<HttpEvent<Entreprise>>;
public lireEntreprise(id: Signal<string> | string, reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<any> {

List GET example:

public listerEntreprises(status: Signal<Array<'available' | 'pending' | 'sold'>> | Array<'available' | 'pending' | 'sold'>, reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<Array<Entreprise>>;
public listerEntreprises(status: Signal<Array<'available' | 'pending' | 'sold'>> | Array<'available' | 'pending' | 'sold'>, reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<HttpResponse<Array<Entreprise>>>;
public listerEntreprises(status: Signal<Array<'available' | 'pending' | 'sold'>> | Array<'available' | 'pending' | 'sold'>, reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<HttpEvent<Array<Entreprise>>>;
public listerEntreprises(status: Signal<Array<'available' | 'pending' | 'sold'>> | Array<'available' | 'pending' | 'sold'>, reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): HttpResourceRef<any> {

Cheers,
Adrian

N.B. This PR targets typescript, so I mention the technical comitee @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)

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 WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Add support for Angular httpResource.

The support is added only for GET request as adviced
by Angular docs:

```
TIP: Avoid using httpResource for mutations like POST or PUT.
Instead, prefer directly using the underlying HttpClient APIs.
```

non-GET methods still rely on rxjs.
@gonzalad gonzalad force-pushed the feature/angular-http-resource branch from 9659bab to f3e3dd7 Compare December 12, 2025 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant