Merge pull request #3294 from cbornet/spring_cloud

[Spring] Add a generator for spring cloud feign clients

Author: wing328

bin/spring-cloud-feign-petstore.json

@@ -0,0 +1,4 @@
+{
+    "library": "spring-cloud",
+    "artifactId": "swagger-petstore-spring-cloud"
+}

bin/spring-cloud-feign-petstore.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+SCRIPT="$0"
+
+while [ -h "$SCRIPT" ] ; do
+  ls=`ls -ld "$SCRIPT"`
+  link=`expr "$ls" : '.*-> \(.*\)$'`
+  if expr "$link" : '/.*' > /dev/null; then
+    SCRIPT="$link"
+  else
+    SCRIPT=`dirname "$SCRIPT"`/"$link"
+  fi
+done
+
+if [ ! -d "${APP_DIR}" ]; then
+  APP_DIR=`dirname "$SCRIPT"`/..
+  APP_DIR=`cd "${APP_DIR}"; pwd`
+fi
+
+executable="./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]
+then
+  mvn clean package
+fi
+
+# if you've executed sbt assembly previously it will use that instead.
+export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
+ags="$@ generate -t modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-cloud -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l spring -c bin/spring-cloud-feign-petstore.json -o samples/client/petstore/spring-cloud -DhideGenerationTimestamp=true"
+
+echo "Removing files and folders under samples/client/petstore/spring-cloud/src/main"
+rm -rf samples/client/petstore/spring-cloud/src/main
+find samples/client/petstore/spring-cloud -maxdepth 1 -type f ! -name "README.md" -exec rm {} +
+java $JAVA_OPTS -jar $executable $ags

bin/spring-mvc-petstore-server.json

@@ -0,0 +1,4 @@
+{
+    "library": "spring-mvc",
+    "artifactId": "swagger-spring-mvc-server"
+}

bin/spring-mvc-petstore-server.sh

@@ -26,6 +26,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="$@ generate -t modules/swagger-codegen/src/main/resources/JavaSpring -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l spring --library spring-mvc -o samples/server/petstore/spring-mvc -DhideGenerationTimestamp=true"
+ags="$@ generate -t modules/swagger-codegen/src/main/resources/JavaSpring -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l spring -c bin/spring-mvc-petstore-server.json -o samples/server/petstore/spring-mvc -DhideGenerationTimestamp=true"
 
 java $JAVA_OPTS -jar $executable $ags

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenSecurity.java

@@ -13,6 +13,7 @@ public class CodegenSecurity {
     // Oauth specific
     public String flow, authorizationUrl, tokenUrl;
     public List<Map<String, Object>> scopes;
+    public Boolean isCode, isPassword, isApplication, isImplicit;
 
     @Override
     public String toString() {
@@ -50,6 +51,14 @@ public boolean equals(Object o) {
             return false;
         if (tokenUrl != null ? !tokenUrl.equals(that.tokenUrl) : that.tokenUrl != null)
             return false;
+        if (isCode != null ? !isCode.equals(that.isCode) : that.isCode != null)
+            return false;
+        if (isPassword != null ? !isPassword.equals(that.isPassword) : that.isPassword != null)
+            return false;
+        if (isApplication != null ? !isApplication.equals(that.isApplication) : that.isApplication != null)
+            return false;
+        if (isImplicit != null ? !isImplicit.equals(that.isImplicit) : that.isImplicit != null)
+            return false;
         return scopes != null ? scopes.equals(that.scopes) : that.scopes == null;
 
     }
@@ -68,6 +77,10 @@ public int hashCode() {
         result = 31 * result + (flow != null ? flow.hashCode() : 0);
         result = 31 * result + (authorizationUrl != null ? authorizationUrl.hashCode() : 0);
         result = 31 * result + (tokenUrl != null ? tokenUrl.hashCode() : 0);
+        result = 31 * result + (isCode != null ? isCode.hashCode() : 0);
+        result = 31 * result + (isPassword != null ? isPassword.hashCode() : 0);
+        result = 31 * result + (isApplication != null ? isApplication.hashCode() : 0);
+        result = 31 * result + (isImplicit != null ? isImplicit.hashCode() : 0);
         result = 31 * result + (scopes != null ? scopes.hashCode() : 0);
         return result;
     }

modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java

@@ -2351,6 +2351,7 @@ public List<CodegenSecurity> fromSecurity(Map<String, SecuritySchemeDefinition>
             CodegenSecurity sec = CodegenModelFactory.newInstance(CodegenModelType.SECURITY);
             sec.name = entry.getKey();
             sec.type = schemeDefinition.getType();
+            sec.isCode = sec.isPassword = sec.isApplication = sec.isImplicit = false;
 
             if (schemeDefinition instanceof ApiKeyAuthDefinition) {
                 final ApiKeyAuthDefinition apiKeyDefinition = (ApiKeyAuthDefinition) schemeDefinition;
@@ -2367,6 +2368,22 @@ public List<CodegenSecurity> fromSecurity(Map<String, SecuritySchemeDefinition>
             	sec.isKeyInHeader = sec.isKeyInQuery = sec.isApiKey = sec.isBasic = false;
                 sec.isOAuth = true;
                 sec.flow = oauth2Definition.getFlow();
+                switch(sec.flow) {
+                    case "accessCode":
+                        sec.isCode = true;
+                        break;
+                    case "password":
+                        sec.isPassword = true;
+                        break;
+                    case "application":
+                        sec.isApplication = true;
+                        break;
+                    case "implicit":
+                        sec.isImplicit = true;
+                        break;
+                    default:
+                        throw new RuntimeException("unknown oauth flow: " + sec.flow);
+                }
                 sec.authorizationUrl = oauth2Definition.getAuthorizationUrl();
                 sec.tokenUrl = oauth2Definition.getTokenUrl();
                 if (oauth2Definition.getScopes() != null) {

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SpringCodegen.java

@@ -11,13 +11,17 @@
 
 public class SpringCodegen extends AbstractJavaCodegen {
     public static final String DEFAULT_LIBRARY = "spring-boot";
+    public static final String TITLE = "title";
     public static final String CONFIG_PACKAGE = "configPackage";
     public static final String BASE_PACKAGE = "basePackage";
     public static final String INTERFACE_ONLY = "interfaceOnly";
     public static final String SINGLE_CONTENT_TYPES = "singleContentTypes";
     public static final String JAVA_8 = "java8";
     public static final String ASYNC = "async";
-    protected String title = "Petstore Server";
+    public static final String SPRING_MVC_LIBRARY = "spring-mvc";
+    public static final String SPRING_CLOUD_LIBRARY = "spring-cloud";
+
+    protected String title = "swagger-petstore";
     protected String configPackage = "io.swagger.configuration";
     protected String basePackage = "io.swagger";
     protected boolean interfaceOnly = false;
@@ -33,12 +37,12 @@ public SpringCodegen() {
         apiPackage = "io.swagger.api";
         modelPackage = "io.swagger.model";
         invokerPackage = "io.swagger.api";
-        artifactId = "swagger-spring-server";
+        artifactId = "swagger-spring";
 
-        additionalProperties.put("title", title);
         additionalProperties.put(CONFIG_PACKAGE, configPackage);
         additionalProperties.put(BASE_PACKAGE, basePackage);
 
+        cliOptions.add(new CliOption(TITLE, "server title name or client service name"));
         cliOptions.add(new CliOption(CONFIG_PACKAGE, "configuration package for generated code"));
         cliOptions.add(new CliOption(BASE_PACKAGE, "base package for generated code"));
         cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files."));
@@ -47,7 +51,8 @@ public SpringCodegen() {
         cliOptions.add(CliOption.newBoolean(ASYNC, "use async Callable controllers"));
 
         supportedLibraries.put(DEFAULT_LIBRARY, "Spring-boot Server application using the SpringFox integration.");
-        supportedLibraries.put("spring-mvc", "Spring-MVC Server application using the SpringFox integration.");
+        supportedLibraries.put(SPRING_MVC_LIBRARY, "Spring-MVC Server application using the SpringFox integration.");
+        supportedLibraries.put(SPRING_CLOUD_LIBRARY, "Spring-Cloud-Feign client with Spring-Boot auto-configured settings.");
         setLibrary(DEFAULT_LIBRARY);
 
         CliOption library = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use");
@@ -82,6 +87,10 @@ public void processOpts() {
         modelDocTemplateFiles.remove("model_doc.mustache");
         apiDocTemplateFiles.remove("api_doc.mustache");
 
+        if (additionalProperties.containsKey(TITLE)) {
+            this.setTitle((String) additionalProperties.get(TITLE));
+        }
+
         if (additionalProperties.containsKey(CONFIG_PACKAGE)) {
             this.setConfigPackage((String) additionalProperties.get(CONFIG_PACKAGE));
         }
@@ -110,17 +119,6 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
 
         if (!this.interfaceOnly) {
-            apiTemplateFiles.put("apiController.mustache", "Controller.java");
-            supportingFiles.add(new SupportingFile("apiException.mustache",
-                    (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiException.java"));
-            supportingFiles.add(new SupportingFile("apiOriginFilter.mustache",
-                    (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiOriginFilter.java"));
-            supportingFiles.add(new SupportingFile("apiResponseMessage.mustache",
-                    (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiResponseMessage.java"));
-            supportingFiles.add(new SupportingFile("notFoundException.mustache",
-                    (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "NotFoundException.java"));
-            supportingFiles.add(new SupportingFile("swaggerDocumentationConfig.mustache",
-                    (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "SwaggerDocumentationConfig.java"));
             if (library.equals(DEFAULT_LIBRARY)) {
                 supportingFiles.add(new SupportingFile("homeController.mustache",
                         (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "HomeController.java"));
@@ -129,7 +127,7 @@ public void processOpts() {
                 supportingFiles.add(new SupportingFile("application.properties",
                         ("src.main.resources").replace(".", java.io.File.separator), "application.properties"));
             }
-            if (library.equals("spring-mvc")) {
+            if (library.equals(SPRING_MVC_LIBRARY)) {
                 supportingFiles.add(new SupportingFile("webApplication.mustache",
                         (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "WebApplication.java"));
                 supportingFiles.add(new SupportingFile("webMvcConfiguration.mustache",
@@ -139,6 +137,31 @@ public void processOpts() {
                 supportingFiles.add(new SupportingFile("application.properties",
                         ("src.main.resources").replace(".", java.io.File.separator), "swagger.properties"));
             }
+            if (library.equals(SPRING_CLOUD_LIBRARY)) {
+                supportingFiles.add(new SupportingFile("apiKeyRequestInterceptor.mustache",
+                        (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "ApiKeyRequestInterceptor.java"));
+                supportingFiles.add(new SupportingFile("clientConfiguration.mustache",
+                        (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "ClientConfiguration.java"));
+                apiTemplateFiles.put("apiClient.mustache", "Client.java");
+                if (!additionalProperties.containsKey(SINGLE_CONTENT_TYPES)) {
+                    additionalProperties.put(SINGLE_CONTENT_TYPES, "true");
+                    this.setSingleContentTypes(true);
+
+                }
+
+            } else {
+                apiTemplateFiles.put("apiController.mustache", "Controller.java");
+                supportingFiles.add(new SupportingFile("apiException.mustache",
+                        (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiException.java"));
+                supportingFiles.add(new SupportingFile("apiResponseMessage.mustache",
+                        (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiResponseMessage.java"));
+                supportingFiles.add(new SupportingFile("notFoundException.mustache",
+                        (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "NotFoundException.java"));
+                supportingFiles.add(new SupportingFile("apiOriginFilter.mustache",
+                        (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiOriginFilter.java"));
+                supportingFiles.add(new SupportingFile("swaggerDocumentationConfig.mustache",
+                        (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "SwaggerDocumentationConfig.java"));
+            }
         }
 
         if (this.java8) {
@@ -182,6 +205,22 @@ public void preprocessSwagger(Swagger swagger) {
             swagger.setBasePath("");
         }
 
+        if(!additionalProperties.containsKey(TITLE)) {
+            // From the title, compute a reasonable name for the package and the API
+            String title = swagger.getInfo().getTitle();
+
+            // Drop any API suffix
+            if (title != null) {
+                title = title.trim().replace(" ", "-");
+                if (title.toUpperCase().endsWith("API")) {
+                    title = title.substring(0, title.length() - 3);
+                }
+
+                this.title = camelize(sanitizeName(title), true);
+            }
+            additionalProperties.put(TITLE, this.title);
+        }
+
         String host = swagger.getHost();
         String port = "8080";
         if (host != null) {
@@ -265,6 +304,19 @@ public Map<String, Object> postProcessOperations(Map<String, Object> objs) {
         return objs;
     }
 
+    @Override
+    public Map<String, Object> postProcessSupportingFileData(Map<String, Object> objs) {
+        if(library.equals(SPRING_CLOUD_LIBRARY)) {
+            List<CodegenSecurity> authMethods = (List<CodegenSecurity>) objs.get("authMethods");
+            if (authMethods != null) {
+                for (CodegenSecurity authMethod : authMethods) {
+                    authMethod.name = camelize(sanitizeName(authMethod.name), true);
+                }
+            }
+        }
+        return objs;
+    }
+
     @Override
     public String toApiName(String name) {
         if (name.length() == 0) {
@@ -274,6 +326,10 @@ public String toApiName(String name) {
         return camelize(name) + "Api";
     }
 
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
     public void setConfigPackage(String configPackage) {
         this.configPackage = configPackage;
     }
@@ -331,4 +387,5 @@ public Map<String, Object> postProcessModelsEnum(Map<String, Object> objs) {
 
         return objs;
     }
+
 }

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-cloud/README.mustache

@@ -0,0 +1,83 @@
+{{^interfaceOnly}}
+# {{artifactId}}
+
+## Requirements
+
+Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
+
+## Installation
+
+To install the API client library to your local Maven repository, simply execute:
+
+```shell
+mvn install
+```
+
+To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
+
+```shell
+mvn deploy
+```
+
+Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
+
+### Maven users
+
+Add this dependency to your project's POM:
+
+```xml
+<dependency>
+    <groupId>{{{groupId}}}</groupId>
+    <artifactId>{{{artifactId}}}</artifactId>
+    <version>{{{artifactVersion}}}</version>
+    <scope>compile</scope>
+</dependency>
+```
+
+### Gradle users
+
+Add this dependency to your project's build file:
+
+```groovy
+compile "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
+```
+
+### Others
+
+At first generate the JAR by executing:
+
+mvn package
+
+Then manually install the following JARs:
+
+* target/{{{artifactId}}}-{{{artifactVersion}}}.jar
+* target/lib/*.jar
+{{/interfaceOnly}}
+{{#interfaceOnly}}
+# Swagger generated API stub
+
+Spring Framework stub
+
+
+## Overview
+This code was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.
+By using the [OpenAPI-Spec](https://github.com/swagger-api/swagger-core), you can easily generate an API stub.
+This is an example of building API stub interfaces in Java using the Spring framework.
+
+The stubs generated can be used in your existing Spring-MVC or Spring-Boot application to create controller endpoints
+by adding ```@Controller``` classes that implement the interface. Eg:
+```java
+@Controller
+public class PetController implements PetApi {
+// implement all PetApi methods
+}
+```
+
+You can also use the interface to create [Spring-Cloud Feign clients](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).Eg:
+```java
+@FeignClient(name="pet", url="http://petstore.swagger.io/v2")
+public interface PetClient extends PetApi {
+
+}
+```
+{{/interfaceOnly}}

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-cloud/apiClient.mustache

@@ -0,0 +1,8 @@
+package {{package}};
+
+import org.springframework.cloud.netflix.feign.FeignClient;
+import {{configPackage}}.ClientConfiguration;
+
+@FeignClient(name="${ {{{title}}}.name:{{{title}}}}", url="${ {{{title}}}.url:{{{basePath}}}}", configuration = ClientConfiguration.class)
+public interface {{classname}}Client extends {{classname}} {
+}