Fixed the produces media type list as specified by the allowedHttpMethods

(6)

Author: dilipkrish

springfox-grails/src/main/java/springfox/documentation/grails/Actions.java

@@ -1,16 +1,33 @@
 package springfox.documentation.grails;
 
+import com.google.common.collect.ImmutableMap;
 import grails.web.Action;
 import groovy.lang.GroovyObject;
+import org.grails.core.DefaultGrailsControllerClass;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import static com.google.common.collect.Sets.*;
 
 class Actions {
 
+  private static final String PROPERTY_RESPONSE_FORMATS = "responseFormats";
+  private static final Map<String, MediaType> mediaTypes = ImmutableMap.<String, MediaType>builder()
+      .put("json", MediaType.APPLICATION_JSON)
+      .put("xml", MediaType.APPLICATION_XML)
+      .build();
+
   private Actions() {
     throw new UnsupportedOperationException();
   }
@@ -28,4 +45,49 @@ static Map<String, HandlerMethod> actionsToHandler(Class grailsController) {
     }
     return handlerLookup;
   }
+
+  static Set<RequestMethod> methodOverrides(GrailsActionContext context) {
+    Set<RequestMethod> methods = new HashSet<>();
+    Map<String, String> allowedMethods;
+    try {
+      Class clazz = context.getController().getClazz();
+      Field allowedMethodsField = clazz
+          .getDeclaredField(DefaultGrailsControllerClass.ALLOWED_HTTP_METHODS_PROPERTY);
+      allowedMethodsField.setAccessible(true);
+      allowedMethods = (Map<String, String>) allowedMethodsField.get(clazz);
+      if (allowedMethods != null && allowedMethods.containsKey(context.getAction())) {
+        methods.add(RequestMethod.valueOf(allowedMethods.get(context.getAction())));
+      }
+    } catch (NoSuchFieldException | IllegalAccessException ignored) {
+    }
+    return methods;
+  }
+
+  private static void setFinalStatic(Field field, Object newValue) throws Exception {
+    field.setAccessible(true);
+
+    Field modifiersField = Field.class.getDeclaredField("modifiers");
+    modifiersField.setAccessible(true);
+    modifiersField.setInt(field, field.getModifiers() & ~Modifier.FINAL);
+
+    field.set(null, newValue);
+  }
+
+  static Set<MediaType> producesOverrides(GrailsActionContext context) {
+    Set<MediaType> produces = newHashSet(MediaType.APPLICATION_JSON);
+    List<String> responseFormats;
+    try {
+      Class clazz = context.getController().getClazz();
+      Field responseFormatFields = clazz.getDeclaredField(PROPERTY_RESPONSE_FORMATS);
+      responseFormatFields.setAccessible(true);
+      responseFormats = (List<String>) responseFormatFields.get(clazz);
+      if (responseFormats != null && !responseFormats.isEmpty()) {
+        return responseFormats.stream()
+            .map(format -> mediaTypes.getOrDefault(format, MediaType.ALL))
+            .collect(Collectors.toSet());
+      }
+    } catch (NoSuchFieldException | IllegalAccessException ignored) {
+    }
+    return produces;
+  }
 }

springfox-grails/src/main/java/springfox/documentation/grails/CreateActionSpecificationFactory.java

@@ -26,7 +26,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Arrays.asList(RequestMethod.POST, RequestMethod.PUT)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Collections.singletonList(

springfox-grails/src/main/java/springfox/documentation/grails/DeleteActionSpecificationFactory.java

@@ -25,7 +25,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Collections.singletonList(RequestMethod.POST)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Collections.singletonList(

springfox-grails/src/main/java/springfox/documentation/grails/EditActionSpecificationFactory.java

@@ -26,7 +26,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Arrays.asList(RequestMethod.POST, RequestMethod.PUT)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)), //May need text/html
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Arrays.asList(

springfox-grails/src/main/java/springfox/documentation/grails/IndexActionSpecificationFactory.java

@@ -26,7 +26,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Collections.singletonList(RequestMethod.GET)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Collections.singletonList(

springfox-grails/src/main/java/springfox/documentation/grails/MethodBackedActionSpecificationFactory.java

@@ -29,7 +29,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         urlProvider.httpMethod(context),
-        new HashSet<>(),
+        producesOverrides(context),
         new HashSet<>(),
         handlerMethod,
         handlerMethodResolver.methodParameters(handlerMethod),

springfox-grails/src/main/java/springfox/documentation/grails/PatchActionSpecificationFactory.java

@@ -26,7 +26,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Arrays.asList(RequestMethod.POST, RequestMethod.PUT)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Arrays.asList(

springfox-grails/src/main/java/springfox/documentation/grails/SaveActionSpecificationFactory.java

@@ -26,7 +26,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Arrays.asList(RequestMethod.POST, RequestMethod.PUT)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Arrays.asList(

springfox-grails/src/main/java/springfox/documentation/grails/ShowActionSpecificationFactory.java

@@ -25,7 +25,7 @@ public ActionSpecification create(GrailsActionContext context) {
     HandlerMethod handlerMethod = actions.get(context.getAction());
     return new ActionSpecification(
         new HashSet<>(Collections.singletonList(RequestMethod.GET)),
-        new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
+        new HashSet<>(producesOverrides(context)),
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Collections.singletonList(

springfox-grails/src/test/groovy/springfox/documentation/grails/MethodBackedActionSpecificationFactorySpec.groovy

@@ -7,6 +7,7 @@ import grails.core.GrailsDomainClassProperty
 import grails.web.mapping.LinkGenerator
 import grails.web.mapping.UrlMapping
 import grails.web.mapping.UrlMappings
+import org.springframework.http.MediaType
 import org.springframework.web.bind.annotation.RequestMethod
 import spock.lang.Specification
 
@@ -37,7 +38,7 @@ class MethodBackedActionSpecificationFactorySpec extends Specification {
       def spec = sut.create(new GrailsActionContext(controller, domain, "other"))
     then:
       spec.consumes == [] as Set
-      spec.produces == [] as Set
+      spec.produces == [MediaType.APPLICATION_JSON] as Set
       spec.supportedMethods == [RequestMethod.POST] as Set
       spec.parameters.size() == 2
       spec.parameters[0].parameterType == resolver.resolve(Integer)