Skip to content

Add bearer capability per specific client #21495

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.

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

inemtsev
Copy link

@inemtsev inemtsev commented Jun 30, 2025

The need for this change is that we need to be able to set the bearer Token per request (for Java native library option), we would like to reuse ApiClient (because recreating it is expensive), but bearer token needs to change. We can achieve this by creating a new api class, but reusing the ApiClient.

For example:


var apiClient = new ApiClient(); // reuse this instance across requests
apiClient.setRequestInterceptor(builder -> 
    builder.header("X-API-Key", "your-api-key-here")
);

var authClient = new AuthClient(apiClient); // create new one every use
authClient.setBearerToken(fooToken);

var walletClient = new WalletClient(apiClient); // create new one every use
walletClient.setBearerToken(fooToken)

Related issue: #21487

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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@inemtsev
Copy link
Author

inemtsev commented Jul 1, 2025

@wing328
Copy link
Member

wing328 commented Jul 2, 2025

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@Mattias-Sehlstedt
Copy link
Contributor

Hi @inemtsev,

Instead of instantiating new objects, would an approach similar to this be possible? Where the bearer is instead injected with a supplier, and the type of supplier can determine whether the token is reused for each invocation or if it is uniquely generated/fetched each time?

@inemtsev
Copy link
Author

inemtsev commented Jul 2, 2025

Hi @inemtsev,

Instead of instantiating new objects, would an approach similar to this be possible? Where the bearer is instead injected with a supplier, and the type of supplier can determine whether the token is reused for each invocation or if it is uniquely generated/fetched each time?

This is an interesting approach, but in our case the token is almost always unique. For example a BFF API takes a user token of our customers and fans-out requests to downstream services. One of these downstream APIs needs this token passed on to them to do a secure operation. So basically the token is fairly unique across requests.

@inemtsev
Copy link
Author

inemtsev commented Jul 3, 2025

@wing328 Thanks for the headsup. I think I fixed the emails now and regenerated the samples. Can you please help target the correct release branch?

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.

3 participants