From 4b62b55877ce0b488944805b052fbc9cc728a79f Mon Sep 17 00:00:00 2001 From: William Cheng Date: Mon, 11 Oct 2021 21:10:04 +0800 Subject: [PATCH] use implementation, add min version of maven, gradle (#10571) --- .../src/main/resources/Java/README.mustache | 14 +++++++++++++- .../petstore/java/apache-httpclient/README.md | 9 ++++++++- .../petstore/java/google-api-client/README.md | 9 ++++++++- samples/client/petstore/java/jersey1/README.md | 9 ++++++++- .../java/jersey2-java8-localdatetime/README.md | 11 +++++++++-- .../client/petstore/java/jersey2-java8/README.md | 11 +++++++++-- samples/client/petstore/java/resteasy/README.md | 9 ++++++++- .../petstore/java/resttemplate-withXml/README.md | 9 ++++++++- .../client/petstore/java/resttemplate/README.md | 9 ++++++++- .../petstore/java/vertx-no-nullable/README.md | 9 ++++++++- samples/client/petstore/java/vertx/README.md | 9 ++++++++- .../java/webclient-nulable-arrays/README.md | 9 ++++++++- samples/client/petstore/java/webclient/README.md | 9 ++++++++- .../x-auth-id-alias/java/jersey2-java8/README.md | 11 +++++++++-- .../jersey2-java8-special-characters/README.md | 11 +++++++++-- .../client/petstore/java/jersey2-java8/README.md | 11 +++++++++-- 16 files changed, 138 insertions(+), 21 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/Java/README.mustache b/modules/openapi-generator/src/main/resources/Java/README.mustache index cd2c7af3ee8b..f360a2ac20d7 100644 --- a/modules/openapi-generator/src/main/resources/Java/README.mustache +++ b/modules/openapi-generator/src/main/resources/Java/README.mustache @@ -21,7 +21,12 @@ Building the API client library requires: 1. Java {{#java8}}1.8{{/java8}}{{^java8}}1.7{{/java8}}+ +{{#jersey2}} +2. Maven (3.8.3+)/Gradle (7.2+) +{{/jersey2}} +{{^jersey2}} 2. Maven/Gradle +{{/jersey2}} ## Installation @@ -57,7 +62,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}" + repositories { + mavenCentral() // Needed if the '{{{artifactId}}}' jar has been published to maven central. + mavenLocal() // Needed if the '{{{artifactId}}}' jar has been published to the local maven repo. + } + + dependencies { + implementation "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}" + } ``` ### Others diff --git a/samples/client/petstore/java/apache-httpclient/README.md b/samples/client/petstore/java/apache-httpclient/README.md index e02a1831a5a3..0b6925ac759a 100644 --- a/samples/client/petstore/java/apache-httpclient/README.md +++ b/samples/client/petstore/java/apache-httpclient/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-apache-httpclient:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-apache-httpclient' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-apache-httpclient' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-apache-httpclient:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/google-api-client/README.md b/samples/client/petstore/java/google-api-client/README.md index 28d54d37dd39..71f36e20665d 100644 --- a/samples/client/petstore/java/google-api-client/README.md +++ b/samples/client/petstore/java/google-api-client/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-google-api-client:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-google-api-client' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-google-api-client' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-google-api-client:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/jersey1/README.md b/samples/client/petstore/java/jersey1/README.md index 1b77ba89cf8b..1ee4072792d0 100644 --- a/samples/client/petstore/java/jersey1/README.md +++ b/samples/client/petstore/java/jersey1/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-java-client-jersey1:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-java-client-jersey1' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-java-client-jersey1' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-java-client-jersey1:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/jersey2-java8-localdatetime/README.md b/samples/client/petstore/java/jersey2-java8-localdatetime/README.md index 352959892aa4..0a774fa64d05 100644 --- a/samples/client/petstore/java/jersey2-java8-localdatetime/README.md +++ b/samples/client/petstore/java/jersey2-java8-localdatetime/README.md @@ -14,7 +14,7 @@ This spec is mainly for testing Petstore server and contains fake endpoints, mod Building the API client library requires: 1. Java 1.8+ -2. Maven/Gradle +2. Maven (3.8.3+)/Gradle (7.2+) ## Installation @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-jersey2-java8-localdatetime:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-jersey2-java8-localdatetime' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-jersey2-java8-localdatetime' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-jersey2-java8-localdatetime:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/jersey2-java8/README.md b/samples/client/petstore/java/jersey2-java8/README.md index 21010fa54124..982cb0b17125 100644 --- a/samples/client/petstore/java/jersey2-java8/README.md +++ b/samples/client/petstore/java/jersey2-java8/README.md @@ -14,7 +14,7 @@ This spec is mainly for testing Petstore server and contains fake endpoints, mod Building the API client library requires: 1. Java 1.8+ -2. Maven/Gradle +2. Maven (3.8.3+)/Gradle (7.2+) ## Installation @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-jersey2-java8:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-jersey2-java8' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-jersey2-java8' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-jersey2-java8:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/resteasy/README.md b/samples/client/petstore/java/resteasy/README.md index 76e72e161d45..0c870fbabb3a 100644 --- a/samples/client/petstore/java/resteasy/README.md +++ b/samples/client/petstore/java/resteasy/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-resteasy:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-resteasy' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-resteasy' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-resteasy:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/resttemplate-withXml/README.md b/samples/client/petstore/java/resttemplate-withXml/README.md index 79f62ec9e8ae..8fdc6181a985 100644 --- a/samples/client/petstore/java/resttemplate-withXml/README.md +++ b/samples/client/petstore/java/resttemplate-withXml/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-resttemplate-withxml:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-resttemplate-withxml' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-resttemplate-withxml' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-resttemplate-withxml:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/resttemplate/README.md b/samples/client/petstore/java/resttemplate/README.md index 87cb5a0cc9c8..fec37d43ba55 100644 --- a/samples/client/petstore/java/resttemplate/README.md +++ b/samples/client/petstore/java/resttemplate/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-resttemplate:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-resttemplate' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-resttemplate' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-resttemplate:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/vertx-no-nullable/README.md b/samples/client/petstore/java/vertx-no-nullable/README.md index 14a2bd16e119..34fb7c44be66 100644 --- a/samples/client/petstore/java/vertx-no-nullable/README.md +++ b/samples/client/petstore/java/vertx-no-nullable/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-vertx-no-nullable:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-vertx-no-nullable' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-vertx-no-nullable' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-vertx-no-nullable:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/vertx/README.md b/samples/client/petstore/java/vertx/README.md index dd6d48dbbe77..a463020f75b8 100644 --- a/samples/client/petstore/java/vertx/README.md +++ b/samples/client/petstore/java/vertx/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-vertx:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-vertx' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-vertx' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-vertx:1.0.0" + } ``` ### Others diff --git a/samples/client/petstore/java/webclient-nulable-arrays/README.md b/samples/client/petstore/java/webclient-nulable-arrays/README.md index c74918e7d1ce..d290aad04980 100644 --- a/samples/client/petstore/java/webclient-nulable-arrays/README.md +++ b/samples/client/petstore/java/webclient-nulable-arrays/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-webclient-nullable-arrays:v1" + repositories { + mavenCentral() // Needed if the 'petstore-webclient-nullable-arrays' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-webclient-nullable-arrays' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-webclient-nullable-arrays:v1" + } ``` ### Others diff --git a/samples/client/petstore/java/webclient/README.md b/samples/client/petstore/java/webclient/README.md index a334fd7f801f..f0b09f824011 100644 --- a/samples/client/petstore/java/webclient/README.md +++ b/samples/client/petstore/java/webclient/README.md @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-webclient:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-webclient' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-webclient' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-webclient:1.0.0" + } ``` ### Others diff --git a/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md b/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md index 4b9a815e8ae2..c16d0a5f2fb7 100644 --- a/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md +++ b/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md @@ -14,7 +14,7 @@ This specification shows how to use x-auth-id-alias extension for API keys. Building the API client library requires: 1. Java 1.7+ -2. Maven/Gradle +2. Maven (3.8.3+)/Gradle (7.2+) ## Installation @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:openapi3-extensions-x-auth-id-alias-jersey2-java8:1.0.0" + repositories { + mavenCentral() // Needed if the 'openapi3-extensions-x-auth-id-alias-jersey2-java8' jar has been published to maven central. + mavenLocal() // Needed if the 'openapi3-extensions-x-auth-id-alias-jersey2-java8' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:openapi3-extensions-x-auth-id-alias-jersey2-java8:1.0.0" + } ``` ### Others diff --git a/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md b/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md index d7b835f508a0..d58ea10bdc01 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md @@ -14,7 +14,7 @@ test Building the API client library requires: 1. Java 1.8+ -2. Maven/Gradle +2. Maven (3.8.3+)/Gradle (7.2+) ## Installation @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-openapi3-jersey2-java8-special-characters:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-openapi3-jersey2-java8-special-characters' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-openapi3-jersey2-java8-special-characters' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-openapi3-jersey2-java8-special-characters:1.0.0" + } ``` ### Others diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/README.md b/samples/openapi3/client/petstore/java/jersey2-java8/README.md index 0c9137a14d96..4e49a39330ae 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/README.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8/README.md @@ -14,7 +14,7 @@ This spec is mainly for testing Petstore server and contains fake endpoints, mod Building the API client library requires: 1. Java 1.8+ -2. Maven/Gradle +2. Maven (3.8.3+)/Gradle (7.2+) ## Installation @@ -50,7 +50,14 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:petstore-openapi3-jersey2-java8:1.0.0" + repositories { + mavenCentral() // Needed if the 'petstore-openapi3-jersey2-java8' jar has been published to maven central. + mavenLocal() // Needed if the 'petstore-openapi3-jersey2-java8' jar has been published to the local maven repo. + } + + dependencies { + implementation "org.openapitools:petstore-openapi3-jersey2-java8:1.0.0" + } ``` ### Others