[java] Support templated servers by jirikuncar · Pull Request #4998 · OpenAPITools/openapi-generator

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

jirikuncar · 2020-01-14T17:07:29Z

Adds support for multiple templated servers from OpenAPI specification.

See related PR for Go: #4635
Addresses #590

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10

auto-labeler · 2020-01-14T17:07:35Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

bkabrda

Very nice! I left two comments inline to consider, but they are really minor things. (Not a member of Java language committee, but hopefully the comments would be helpful anyway).

…uration.mustache

…int-servers

jimschubert

This looks excellent!

jimschubert · 2020-02-16T16:12:30Z

 // to support (constant) query string in `path`, e.g. "/posts?draft=1"
- WebTarget target = httpClient.target(this.basePath + path);
+ String targetURL;
+ if (serverIndex != null) {


Notice here to consumers that if new server variable functionality causes issue, one may call setServerIndex(null) to revert to previous behavior. Current default behavior with the server index 0 behaves in the same way as before, but moves the URL configuration to the servers array.

jimschubert · 2020-02-16T16:16:33Z

This is great and adds functionality that most clients don't support. The samples are out of date which caused the build failures. I'll fix that and let the builds run, but then I'd like to merge this so people have some time to evaluate on SNAPSHOT before the 4.3.0 release in a couple weeks.

* [java] Support templated servers * Deprecate old signature of invokeAPI method * throw ArrayIndexOutOfBoundsException * Update modules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache * [java] Regenerate samples Co-authored-by: Jim Schubert <james.schubert@gmail.com>

ChristianCiach · 2020-07-21T10:31:59Z

Please see a09271e#r40779493

auto-labelerBot added the Client: Java label Jan 14, 2020

jirikuncar force-pushed the java-client-endpoint-servers branch from 847ba8a to f1ddc18Compare January 15, 2020 14:47

[java] Support templated servers
594f055

jirikuncar force-pushed the java-client-endpoint-servers branch from f1ddc18 to 594f055Compare January 15, 2020 16:28

bkabrda reviewed Jan 15, 2020
View reviewed changes

Comment threadmodules/openapi-generator/src/main/resources/Java/ApiClient.mustache Outdated
Comment threadmodules/openapi-generator/src/main/resources/Java/libraries/jersey2/ApiClient.mustache

jirikuncar added 4 commits January 15, 2020 18:17

Deprecate old signature of invokeAPI method
807ece0

Regenerated
6577bde

throw ArrayIndexOutOfBoundsException
5b93d63

Regenerated
07965b9

jirikuncar requested a review from wing328 January 16, 2020 15:13

Merge branch 'master' into java-client-endpoint-servers
09b84f5

jirikuncar requested a review from jimschubert January 21, 2020 16:09

jirikuncar commented Feb 11, 2020
View reviewed changes

Comment threadmodules/openapi-generator/src/main/resources/Java/ServerConfiguration.mustache Outdated

jirikuncar added 2 commits February 11, 2020 16:48

Update modules/openapi-generator/src/main/resources/Java/ServerConfig…
edca168
…uration.mustache

Regenerated
d98c7dd

jirikuncar force-pushed the java-client-endpoint-servers branch from 63219ab to d98c7ddCompare February 11, 2020 15:51

jimschubert self-assigned this Feb 11, 2020

jirikuncar added 3 commits February 12, 2020 10:16

Merge remote-tracking branch 'upstream/master' into java-client-endpo…
fe93888
…int-servers

Fix imports and typo in index name
b0b1cfe

Fix javadoc
e299f8d

jimschubert approved these changes Feb 16, 2020
View reviewed changes

jimschubert added this to the 4.3.0 milestone Feb 16, 2020

[java] Regenerate samples
63a26c8

jirikuncar requested a review from jimschubert February 19, 2020 14:10

jimschubert merged commit a09271e into OpenAPITools:masterFeb 19, 2020

jimschubert added Enhancement: Feature Feature: OAS 3.0 spec support labels Feb 19, 2020

jirikuncar deleted the java-client-endpoint-servers branch February 19, 2020 15:52

jimschubert mentioned this pull request Feb 20, 2020
[go][java] Document new parameterized server support #5380
Merged
5 tasks

trussell314 mentioned this pull request Mar 23, 2020
[REQ][Java][resttemplate] Add templated server support to Java resttemplate client #5678
Open

afrische mentioned this pull request Apr 2, 2020
[BUG][Java] templated servers broke simple setting of basepath #5799
Open
2 tasks

jirikuncar mentioned this pull request Jun 5, 2020
[Python] Support for per-operation servers #6557
Merged
5 tasks

jdussouillez mentioned this pull request Jul 10, 2020
[REQ][Java][Native] Add templated server support to Java native client #6905
Open

outscale-mdr mentioned this pull request Dec 5, 2022
[Java][Client] Generate servers for okhttp-gson #14179
Merged
5 tasks

rgcv mentioned this pull request Aug 5, 2025
[Java][RestClient] Generate servers for restclient library #21699
Merged
6 tasks

Mattias-Sehlstedt mentioned this pull request Jun 13, 2026
[Java] [Spring Client] Add an exception provider interface to allow for exception redefinition #23878
Merged
6 tasks