Skip to content

Conversation

ronreynolds
Copy link
Contributor

a backwards-compatible enhancement to Configuration that supports:

  • providing an Supplier<ApiClient> as a factory so that when the ApiClient is created using code can alter it while still using Configuration.getDefaultApiClient(). this also means that all *Api no-arg ctors will also use it.
  • thread-safe changes to defaultApiClient beyond the volatile added earlier

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.

Java Technical Committee

@bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg

@ronreynolds
Copy link
Contributor Author

sample usage of new ApiClient factory:

  static {
    Configuration.setApiClientFactory(() -> createClientForShop(defaultShopId));
  }

  public static ApiClient createClientForShop(Long shopId) {
    ApiClient apiClient = new ApiClient();
    apiClient.setRequestInterceptor(builder -> prepRequest(builder, shopId));  // adds required auth headers; optional request logging
    apiClient.setResponseInterceptor(ApiClients::processResponse);  // adds optional response logging          
    return apiClient;
  }

this callback would also allow user-code to extend ApiClient behavior via sub-classing; unfortunately much of that is currently being invoked via static methods in java-native; to be addressed in a future PR.

@ronreynolds
Copy link
Contributor Author

#20769

@wing328 wing328 merged commit 5cef080 into OpenAPITools:master Mar 3, 2025
101 checks passed
@wing328 wing328 added this to the 7.13.0 milestone Mar 3, 2025
JacobOJ pushed a commit to JacobOJ/openapi-generator that referenced this pull request Mar 3, 2025
…ols#20738)

* enhanced Configuration.mustache (thread-safe, lazy-eval, plugable factory

* removed comment in Configuration.mustache

* fresh samples
@ronreynolds
Copy link
Contributor Author

NOTE
this PR does create an unintended but observable change in code behavior; if one calls Configuration.setDefaultApiClient(null) the previous code would return null from Configuration.getDefaultApiClient(). it will now create a new ApiClient via the apiClientFactory. baring a factory that returns null getDefaultApiClient() will NEVER return null.

kpy3 pushed a commit to kpy3/openapi-generator that referenced this pull request Mar 13, 2025
…ols#20738)

* enhanced Configuration.mustache (thread-safe, lazy-eval, plugable factory

* removed comment in Configuration.mustache

* fresh samples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants