Skip to content

[JAVA] Add generic okhttp client #24734

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

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

[JAVA] Add generic okhttp client #24734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8f86752
[java][okhttp] Add okhttp library supporting Gson, Jackson 2/3 and JS…
rar91279 Aug 19, 2026
e9bbd5c
[java] Rename okhttp-gson user-defined-templates config to match its …
rar91279 Aug 19, 2026
10f1f34
[java][okhttp] Add sample configurations for the okhttp library
rar91279 Aug 19, 2026
78d1958
[java][okhttp] Wire okhttp samples into CI and refresh generator docs
rar91279 Aug 19, 2026
a6ce093
[java][okhttp] Regenerate samples for the okhttp library
rar91279 Aug 19, 2026
b7334df
[java][okhttp] Regenerate samples against a clean build
rar91279 Aug 19, 2026
a268fb0
[java][okhttp] Fix defects found in review of the new library
rar91279 Aug 19, 2026
4f784ab
[java][okhttp] Route the Jackson 3 JsonTypeName import through model.…
rar91279 Aug 19, 2026
8537d4f
Update generator docs: Add okhttp library details and support for `us…
rar91279 Aug 19, 2026
f1fcc3f
Merge branch 'OpenAPITools:master' into java-generic-okhttp
rar91279 Aug 19, 2026
7653c18
Merge remote-tracking branch 'origin/java-generic-okhttp' into java-g…
rar91279 Aug 19, 2026
d7145f5
Update samples/client/others/java/okhttp-jackson-oneOf/git_push.sh
rar91279 Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 2 additions & 0 deletions .github/workflows/gradle-test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ jobs:
- samples/client/petstore/java/jersey2-java8
- samples/client/petstore/java/okhttp-gson
- samples/client/petstore/java/okhttp-gson-group-parameter
- samples/client/petstore/java/okhttp
- samples/client/petstore/java/okhttp-group-parameter
- samples/client/petstore/java/webclient-swagger2
- samples/client/petstore/java/native
- samples/client/petstore/java/native-jakarta
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/samples-java-client-echo-api-jdk8.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ on:
- samples/client/echo_api/java/apache-httpclient/**
- samples/client/echo_api/java/feign-gson/**
- samples/client/echo_api/java/okhttp-gson/**
- samples/client/echo_api/java/okhttp/**
- samples/client/echo_api/java/resttemplate/**
- samples/client/echo_api/java/resteasy/**
pull_request:
paths:
- samples/client/echo_api/java/apache-httpclient/**
- samples/client/echo_api/java/feign-gson/**
- samples/client/echo_api/java/okhttp-gson/**
- samples/client/echo_api/java/okhttp/**
- samples/client/echo_api/java/resteasy/**
jobs:
build:
Expand All @@ -26,6 +28,7 @@ jobs:
- samples/client/echo_api/java/apache-httpclient
- samples/client/echo_api/java/feign-gson
- samples/client/echo_api/java/okhttp-gson
- samples/client/echo_api/java/okhttp
- samples/client/echo_api/java/resttemplate
- samples/client/echo_api/java/resteasy
steps:
Expand Down
37 changes: 37 additions & 0 deletions .github/workflows/samples-java-client-jdk11.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,19 @@ on:
- samples/openapi3/client/petstore/java/native**
- samples/client/others/java/okhttp-gson-oneOf/**
- samples/client/others/java/okhttp-gson-oneOf-array/**
- samples/client/others/java/okhttp-oneOf/**
- samples/client/others/java/okhttp-oneOf-array/**
- samples/client/others/java/okhttp-jackson-oneOf/**
- samples/client/others/java/okhttp-jackson3-oneOf/**
- samples/client/others/java/okhttp-jsonb-oneOf/**
- samples/client/others/java/resttemplate-useAbstractionForFiles/**
- samples/client/others/java/webclient-useAbstractionForFiles/**
- samples/client/petstore/java/webclient-useSingleRequestParameter/**
- samples/client/others/java/jersey2-oneOf-duplicates/**
- samples/client/others/java/jersey2-oneOf-Mixed/**
- samples/client/others/java/okhttp-gson-streaming/**
- samples/client/others/java/okhttp-streaming/**
- samples/client/echo_api/java/okhttp**
- samples/client/others/java/resteasy/**
- samples/client/others/java/apache-httpclient/**
- samples/client/others/java/resttemplate-list-schema-validation/**
Expand All @@ -35,12 +42,19 @@ on:
- samples/openapi3/client/petstore/java/native**
- samples/client/others/java/okhttp-gson-oneOf/**
- samples/client/others/java/okhttp-gson-oneOf-array/**
- samples/client/others/java/okhttp-oneOf/**
- samples/client/others/java/okhttp-oneOf-array/**
- samples/client/others/java/okhttp-jackson-oneOf/**
- samples/client/others/java/okhttp-jackson3-oneOf/**
- samples/client/others/java/okhttp-jsonb-oneOf/**
- samples/client/others/java/resttemplate-useAbstractionForFiles/**
- samples/client/others/java/webclient-useAbstractionForFiles/**
- samples/client/petstore/java/webclient-useSingleRequestParameter/**
- samples/client/others/java/jersey2-oneOf-duplicates/**
- samples/client/others/java/jersey2-oneOf-Mixed/**
- samples/client/others/java/okhttp-gson-streaming/**
- samples/client/others/java/okhttp-streaming/**
- samples/client/echo_api/java/okhttp**
- samples/client/others/java/resteasy/**
- samples/client/others/java/apache-httpclient/**
- samples/client/others/java/resttemplate-list-schema-validation/**
Expand Down Expand Up @@ -93,24 +107,47 @@ jobs:
- samples/client/petstore/java/feign-hc5
- samples/client/petstore/java/feign-no-nullable
- samples/client/petstore/java/okhttp-gson-awsv4signature
- samples/client/petstore/java/okhttp-awsv4signature
- samples/openapi3/client/petstore/java/jersey2-java8-special-characters
- samples/openapi3/client/petstore/java/native
- samples/client/petstore/java/okhttp-gson-swagger1/
- samples/client/petstore/java/okhttp-swagger1/
- samples/client/petstore/java/resttemplate-swagger1/
- samples/openapi3/client/petstore/java/jersey2-java8-swagger1/
- samples/client/petstore/java/okhttp-gson-swagger2/
- samples/client/petstore/java/okhttp-swagger2/
- samples/client/petstore/java/resttemplate-swagger2/
- samples/openapi3/client/petstore/java/jersey2-java8-swagger2/
- samples/client/others/java/okhttp-gson-oneOf/
- samples/client/others/java/okhttp-gson-oneOf-array/
- samples/client/others/java/okhttp-oneOf/
- samples/client/others/java/okhttp-oneOf-array/
- samples/client/others/java/okhttp-jackson-oneOf/
- samples/client/others/java/okhttp-jackson3-oneOf/
- samples/client/others/java/okhttp-jsonb-oneOf/
- samples/client/echo_api/java/okhttp-gson-user-defined-templates/
- samples/client/echo_api/java/okhttp-user-defined-templates/
- samples/client/echo_api/java/okhttp-jackson-user-defined-templates/
- samples/client/others/java/resttemplate-useAbstractionForFiles/
- samples/client/others/java/webclient-useAbstractionForFiles/
- samples/client/others/java/jersey2-oneOf-duplicates/
- samples/client/others/java/jersey2-oneOf-Mixed/
- samples/client/others/java/resttemplate-list-schema-validation/
- samples/client/petstore/java/okhttp-gson-3.1-duplicated-operationid/
- samples/client/petstore/java/okhttp-3.1-duplicated-operationid/
- samples/client/others/java/okhttp-gson-streaming/
- samples/client/others/java/okhttp-streaming/
- samples/client/petstore/java/okhttp-jackson/
- samples/client/petstore/java/okhttp-jackson3/
- samples/client/petstore/java/okhttp-jsonb/
- samples/client/petstore/java/okhttp-jackson-jspecify/
- samples/client/petstore/java/okhttp-jackson3-jspecify/
- samples/client/petstore/java/okhttp-jsonb-jspecify/
- samples/client/petstore/java/okhttp-nullable-required/
- samples/client/petstore/java/okhttp-jackson-nullable-required/
- samples/client/petstore/java/okhttp-jsonb-nullable-required/
- samples/client/petstore/java/okhttp-group-parameter/
- samples/client/petstore/java/okhttp-parcelableModel/
- samples/client/petstore/java/resteasy/
- samples/client/petstore/java/apache-httpclient/
steps:
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/samples-java-petsore-client-jdk11.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
- samples/client/petstore/java/okhttp-gson/**
- samples/client/petstore/java/okhttp-gson-3.1/**
- samples/client/petstore/java/okhttp-gson-dynamicOperations/**
- samples/client/petstore/java/okhttp/**
- samples/client/petstore/java/okhttp-3.1/**
- samples/client/petstore/java/okhttp-dynamicOperations/**
- samples/client/petstore/java-micronaut-client/**
pull_request:
paths:
Expand All @@ -17,6 +20,9 @@ on:
- samples/client/petstore/java/okhttp-gson/**
- samples/client/petstore/java/okhttp-gson-3.1/**
- samples/client/petstore/java/okhttp-gson-dynamicOperations/**
- samples/client/petstore/java/okhttp/**
- samples/client/petstore/java/okhttp-3.1/**
- samples/client/petstore/java/okhttp-dynamicOperations/**
- samples/client/petstore/java-micronaut-client/**
jobs:
build:
Expand All @@ -31,6 +37,9 @@ jobs:
- samples/client/petstore/java/okhttp-gson
- samples/client/petstore/java/okhttp-gson-3.1
- samples/client/petstore/java/okhttp-gson-dynamicOperations
- samples/client/petstore/java/okhttp
- samples/client/petstore/java/okhttp-3.1
- samples/client/petstore/java/okhttp-dynamicOperations
- samples/client/petstore/java-micronaut-client
services:
petstore-api:
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/samples-java-sbt.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ on:
push:
paths:
- 'samples/client/petstore/java/okhttp-gson/**'
- 'samples/client/petstore/java/okhttp/**'
pull_request:
paths:
- 'samples/client/petstore/java/okhttp-gson/**'
- 'samples/client/petstore/java/okhttp/**'
jobs:
build:
name: Build sbt/Java client, servers
Expand All @@ -17,6 +19,7 @@ jobs:
sample:
# clients
- samples/client/petstore/java/okhttp-gson
- samples/client/petstore/java/okhttp
steps:
- uses: actions/checkout@v7
- uses: actions/setup-java@v5.7.0
Expand Down
13 changes: 13 additions & 0 deletions bin/configs/java-okhttp-3.1-duplicated-operationid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-3.1-duplicated-operationid
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_1/java/duplicated_operationid.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
validateSpec: false
additionalProperties:
serializationLibrary: gson
artifactId: petstore-okhttp-31-do
hideGenerationTimestamp: "true"
disallowAdditionalPropertiesIfNotPresent: false
openapiNormalizer:
FIX_DUPLICATED_OPERATIONID: true
21 changes: 21 additions & 0 deletions bin/configs/java-okhttp-3.1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-3.1
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_1/java/petstore.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
validateSpec: false
nameMappings:
_type: underscoreType
type_: typeWithUnderscore
parameterNameMappings:
_type: underscoreType
type_: typeWithUnderscore
additionalProperties:
serializationLibrary: gson
artifactId: petstore-okhttp-31
hideGenerationTimestamp: "true"
useOneOfDiscriminatorLookup: "true"
disallowAdditionalPropertiesIfNotPresent: false
enumPropertyNaming: legacy
openapiNormalizer:
FIX_DUPLICATED_OPERATIONID: true
12 changes: 12 additions & 0 deletions bin/configs/java-okhttp-awsv4signature.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-awsv4signature
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: gson
artifactId: okhttp-awsv4signature
hideGenerationTimestamp: "true"
useOneOfDiscriminatorLookup: "true"
disallowAdditionalPropertiesIfNotPresent: false
withAWSV4Signature: true
10 changes: 10 additions & 0 deletions bin/configs/java-okhttp-dynamicOperations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-dynamicOperations
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: gson
artifactId: petstore-okhttp-dynamicoperations
hideGenerationTimestamp: "true"
dynamicOperations: "true"
9 changes: 9 additions & 0 deletions bin/configs/java-okhttp-echo-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
generatorName: java
outputDir: samples/client/echo_api/java/okhttp
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/echo_api.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: gson
artifactId: echo-api-okhttp
hideGenerationTimestamp: "true"
11 changes: 11 additions & 0 deletions bin/configs/java-okhttp-group-parameter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-group-parameter
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/java/petstore-group-parameter.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: gson
artifactId: petstore-okhttp-group-parameter
hideGenerationTimestamp: "true"
disallowAdditionalPropertiesIfNotPresent: false
useSingleRequestParameter: true
17 changes: 17 additions & 0 deletions bin/configs/java-okhttp-gson-user-defined-templates.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
generatorName: java
outputDir: samples/client/echo_api/java/okhttp-gson-user-defined-templates
library: okhttp-gson
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
hideGenerationTimestamp: "true"
files:
README.mustache:
destinationFilename: info.md
api_doc.mustache:
templateType: APIDocs
destinationFilename: Documentation.md
pojo.mustache:
templateType: Model
folder: modelCopy
destinationFilename: .java
17 changes: 17 additions & 0 deletions bin/configs/java-okhttp-jackson-jspecify.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-jackson-jspecify
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
validateSpec: false
additionalProperties:
serializationLibrary: jackson
artifactId: petstore-okhttp-jackson-jspecify
hideGenerationTimestamp: "true"
generateBuilders: true
useReflectionEqualsHashCode: "true"
openApiNullable: "false"
useJspecify: true
typeMappings:
OffsetDateTime: java.time.Instant
BigDecimal: java.math.BigDecimal
11 changes: 11 additions & 0 deletions bin/configs/java-okhttp-jackson-nullable-required.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-jackson-nullable-required
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-nullable-required.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: jackson
artifactId: nullable-required-okhttp-jackson
hideGenerationTimestamp: "true"
useOneOfDiscriminatorLookup: "true"
disallowAdditionalPropertiesIfNotPresent: false
9 changes: 9 additions & 0 deletions bin/configs/java-okhttp-jackson-oneOf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
generatorName: java
outputDir: samples/client/others/java/okhttp-jackson-oneOf
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/oneOf_twoPrimitives.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
artifactId: okhttp-jackson-oneOf
hideGenerationTimestamp: "true"
serializationLibrary: jackson
19 changes: 19 additions & 0 deletions bin/configs/java-okhttp-jackson-user-defined-templates.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
generatorName: java
outputDir: samples/client/echo_api/java/okhttp-jackson-user-defined-templates
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/echo_api.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
artifactId: echo-api-okhttp-jackson-user-defined-templates
hideGenerationTimestamp: "true"
serializationLibrary: jackson
files:
README.mustache:
destinationFilename: info.md
api_doc.mustache:
templateType: APIDocs
destinationFilename: Documentation.md
pojo.mustache:
templateType: Model
folder: modelCopy
destinationFilename: .java
12 changes: 12 additions & 0 deletions bin/configs/java-okhttp-jackson.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-jackson
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/java/native/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: jackson
artifactId: petstore-okhttp-jackson2
hideGenerationTimestamp: "true"
generateBuilders: true
useReflectionEqualsHashCode: "true"
openApiNullable: "false"
18 changes: 18 additions & 0 deletions bin/configs/java-okhttp-jackson3-jspecify.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-jackson3-jspecify
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
validateSpec: false
additionalProperties:
serializationLibrary: jackson
artifactId: petstore-okhttp-jackson3-jspecify
hideGenerationTimestamp: "true"
generateBuilders: true
useReflectionEqualsHashCode: "true"
useJackson3: "true"
openApiNullable: "false"
useJspecify: true
typeMappings:
OffsetDateTime: java.time.Instant
BigDecimal: java.math.BigDecimal
10 changes: 10 additions & 0 deletions bin/configs/java-okhttp-jackson3-oneOf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
generatorName: java
outputDir: samples/client/others/java/okhttp-jackson3-oneOf
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/oneOf_twoPrimitives.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
artifactId: okhttp-jackson3-oneOf
hideGenerationTimestamp: "true"
serializationLibrary: jackson
useJackson3: true
13 changes: 13 additions & 0 deletions bin/configs/java-okhttp-jackson3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
generatorName: java
outputDir: samples/client/petstore/java/okhttp-jackson3
library: okhttp
inputSpec: modules/openapi-generator/src/test/resources/3_0/java/native/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: jackson
artifactId: petstore-okhttp-jackson3
hideGenerationTimestamp: "true"
generateBuilders: true
useReflectionEqualsHashCode: "true"
useJackson3: "true"
openApiNullable: "false"
Loading