Skip to content

Commit

Permalink
[Server][Spring] fix support interface and implementation classes for…
Browse files Browse the repository at this point in the history 
… API controllers (#16945)

* [Server][Spring] support interface and implementation classes for API controllers

* Omitted new string calls

* Added Log messages

* remove else

* Removed redundant if

* Update missed ;
  • Loading branch information
@kapilguptavz
kapilguptavz committed Nov 4, 2023
1 parent 171cc67 commit c4b18f2
Show file tree
Hide file tree
Showing 25 changed files with 20 additions and 124 deletions.
23 changes: 20 additions & 3 deletions modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ public class DefaultGenerator implements Generator {
protected TemplateProcessor templateProcessor = null;

private List<TemplateDefinition> userDefinedTemplates = new ArrayList<>();
private String generatorCheck = "spring";
private String templateCheck = "apiController.mustache";


public DefaultGenerator() {
Expand Down Expand Up @@ -694,14 +696,23 @@ void generateApis(List<File> files, List<OperationsMap> allOperations, List<Mode
addAuthenticationSwitches(operation);

for (String templateName : config.apiTemplateFiles().keySet()) {
File written;
File written = null;
if (config.templateOutputDirs().containsKey(templateName)) {
String outputDir = config.getOutputDir() + File.separator + config.templateOutputDirs().get(templateName);
String filename = config.apiFilename(templateName, tag, outputDir);
written = processTemplateToFile(operation, templateName, filename, generateApis, CodegenConstants.APIS, outputDir);
// do not overwrite apiController file for spring server
if (apiFilePreCheck(filename, generatorCheck, templateName, templateCheck)){
written = processTemplateToFile(operation, templateName, filename, generateApis, CodegenConstants.APIS, outputDir);
} else {
LOGGER.info("Implementation file {} is not overwritten",filename);
}
} else {
String filename = config.apiFilename(templateName, tag);
written = processTemplateToFile(operation, templateName, filename, generateApis, CodegenConstants.APIS);
if(apiFilePreCheck(filename, generatorCheck, templateName, templateCheck)){
written = processTemplateToFile(operation, templateName, filename, generateApis, CodegenConstants.APIS);
} else {
LOGGER.info("Implementation file {} is not overwritten",filename);
}
}
if (written != null) {
files.add(written);
Expand Down Expand Up @@ -752,6 +763,12 @@ void generateApis(List<File> files, List<OperationsMap> allOperations, List<Mode

}

// checking if apiController file is already existed for spring generator
private boolean apiFilePreCheck(String filename, String generator, String templateName, String apiControllerTemplate){
File apiFile = new File(filename);
return !(apiFile.exists() && config.getName().equals(generator) && templateName.equals(apiControllerTemplate));
}

private void generateSupportingFiles(List<File> files, Map<String, Object> bundle) {
if (!generateSupportingFiles) {
// TODO: process these anyway and report via dryRun?
Expand Down
2 changes: 0 additions & 2 deletions samples/openapi3/server/petstore/spring-boot-oneof/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/BarApi.java
src/main/java/org/openapitools/api/BarApiController.java
src/main/java/org/openapitools/api/FooApi.java
src/main/java/org/openapitools/api/FooApiController.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
Expand Down
3 changes: 0 additions & 3 deletions samples/openapi3/server/petstore/spring-boot-springdoc/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
src/main/java/org/openapitools/model/Category.java
Expand Down
3 changes: 0 additions & 3 deletions samples/openapi3/server/petstore/springboot-3/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
src/main/java/org/openapitools/model/Category.java
Expand Down
6 changes: 0 additions & 6 deletions samples/openapi3/server/petstore/springboot-delegate/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeApiDelegate.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/PetApiDelegate.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/StoreApiDelegate.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/api/UserApiDelegate.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
Expand Down
6 changes: 0 additions & 6 deletions samples/openapi3/server/petstore/springboot-implicitHeaders/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,12 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
Expand Down
3 changes: 0 additions & 3 deletions samples/openapi3/server/petstore/springboot-source/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/model/Category.java
src/main/java/org/openapitools/model/ModelApiResponse.java
Expand Down
3 changes: 0 additions & 3 deletions samples/openapi3/server/petstore/springboot/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
src/main/java/org/openapitools/model/Category.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,12 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringFoxConfiguration.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-beanvalidation/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,12 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringFoxConfiguration.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-delegate-j8/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeApiDelegate.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/PetApiDelegate.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/StoreApiDelegate.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/api/UserApiDelegate.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
Expand Down
3 changes: 0 additions & 3 deletions samples/server/petstore/springboot-delegate-no-response-entity/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/PetApiDelegate.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/StoreApiDelegate.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/api/UserApiDelegate.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringFoxConfiguration.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-delegate/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeApiDelegate.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/PetApiDelegate.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/StoreApiDelegate.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/api/UserApiDelegate.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
Expand Down
3 changes: 0 additions & 3 deletions ...les/server/petstore/springboot-implicitHeaders-annotationLibrary/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/model/Category.java
src/main/java/org/openapitools/model/ModelApiResponse.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-implicitHeaders/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,12 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
src/main/java/org/openapitools/configuration/SpringFoxConfiguration.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-reactive-noResponseEntity/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeApiDelegate.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/PetApiDelegate.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/StoreApiDelegate.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/api/UserApiDelegate.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
Expand Down
6 changes: 0 additions & 6 deletions samples/server/petstore/springboot-reactive/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ pom.xml
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
src/main/java/org/openapitools/RFC3339DateFormat.java
src/main/java/org/openapitools/api/AnotherFakeApi.java
src/main/java/org/openapitools/api/AnotherFakeApiController.java
src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java
src/main/java/org/openapitools/api/ApiUtil.java
src/main/java/org/openapitools/api/FakeApi.java
src/main/java/org/openapitools/api/FakeApiController.java
src/main/java/org/openapitools/api/FakeApiDelegate.java
src/main/java/org/openapitools/api/FakeClassnameTestApi.java
src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java
src/main/java/org/openapitools/api/PetApi.java
src/main/java/org/openapitools/api/PetApiController.java
src/main/java/org/openapitools/api/PetApiDelegate.java
src/main/java/org/openapitools/api/StoreApi.java
src/main/java/org/openapitools/api/StoreApiController.java
src/main/java/org/openapitools/api/StoreApiDelegate.java
src/main/java/org/openapitools/api/UserApi.java
src/main/java/org/openapitools/api/UserApiController.java
src/main/java/org/openapitools/api/UserApiDelegate.java
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
src/main/java/org/openapitools/configuration/HomeController.java
Expand Down
Loading

0 comments on commit c4b18f2

Please sign in to comment.