Merge pull request #150 from SentryMan/status

Now can override default status code with @produces

Author: rbygrave

http-api/src/main/java/io/avaje/http/api/Produces.java

@@ -24,9 +24,26 @@
  *
  * }</pre>
  */
-@Target(value={TYPE, METHOD})
-@Retention(value=RUNTIME)
+@Target(value = {TYPE, METHOD})
+@Retention(value = RUNTIME)
 public @interface Produces {
 
-  String value();
+  /**
+   * Specify response media type.
+   *
+   * <p>When not specified the default MediaType is APPLICATION_JSON
+   */
+  String value() default MediaType.APPLICATION_JSON;
+
+  /**
+   * The default status code of the generated route.
+   *
+   * <p>When not specified, the default status are as follows: <br>
+   * GET(200) <br>
+   * POST(201) <br>
+   * PUT(200, void methods 204) <br>
+   * PATCH(200, void methods 204) <br>
+   * DELETE(200, void methods 204)
+   */
+  int defaultStatus() default 0;
 }

http-generator-core/src/main/java/io/avaje/http/generator/core/MethodReader.java

@@ -34,7 +34,7 @@ public class MethodReader {
    * Holds enum Roles that are required for the method.
    */
   private final List<String> methodRoles;
-  private final String produces;
+  private final Optional<Produces> producesAnnotation;
   private final List<OpenAPIResponse> apiResponses;
   private final ExecutableType actualExecutable;
   private final List<? extends TypeMirror> actualParams;
@@ -54,7 +54,7 @@ public class MethodReader {
     this.actualParams = (actualExecutable == null) ? null : actualExecutable.getParameterTypes();
     this.isVoid = element.getReturnType().getKind() == TypeKind.VOID;
     this.methodRoles = Util.findRoles(element);
-    this.produces = produces(bean);
+    this.producesAnnotation = Optional.ofNullable(findAnnotation(Produces.class));
     initWebMethodViaAnnotation();
 
     this.superMethods = ctx.superMethods(element.getEnclosingElement(), element.getSimpleName().toString());
@@ -151,11 +151,6 @@ public Javadoc javadoc() {
     return javadoc;
   }
 
-  private String produces(ControllerReader bean) {
-    final var produces = findAnnotation(Produces.class);
-    return (produces != null) ? produces.value() : bean.produces();
-  }
-
   private List<OpenAPIResponse> buildApiResponses() {
     final var container =
       Optional.ofNullable(findAnnotation(OpenAPIResponses.class)).stream()
@@ -275,8 +270,12 @@ public boolean isVoid() {
     return isVoid;
   }
 
+  public boolean hasProducesStatus() {
+    return producesAnnotation.map(Produces::defaultStatus).filter(s -> s > 0).isPresent();
+  }
+
   public String produces() {
-    return produces;
+    return producesAnnotation.map(Produces::value).orElseGet(bean::produces);
   }
 
   public List<OpenAPIResponse> apiResponses() {
@@ -291,7 +290,11 @@ public TypeMirror returnType() {
   }
 
   public String statusCode() {
-    return Integer.toString(webMethod.statusCode(isVoid));
+
+    return producesAnnotation
+        .map(Produces::defaultStatus)
+        .filter(s -> s > 0)
+        .orElseGet(() -> webMethod.statusCode(isVoid)).toString();
   }
 
   public PathSegments pathSegments() {

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/MethodDocBuilder.java

@@ -77,6 +77,7 @@ public void build() {
     response.setDescription(javadoc.getReturnDescription());
 
     final var produces = methodReader.produces();
+    final var hasProducesStatus = methodReader.hasProducesStatus();
     final var contentMediaType = (produces == null) ? MediaType.APPLICATION_JSON : produces;
 
     if (methodReader.isVoid()) {
@@ -99,7 +100,7 @@ public void build() {
       // if user wants to define their own 2xx status code
       if (responseAnnotation.responseCode().startsWith("2")) {
         newResponse.setContent(response.getContent());
-        override2xx = true;
+        override2xx = !hasProducesStatus;
       }
       TypeMirror returnType = null;
       try {

tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/test/OpenAPIController.java

@@ -10,6 +10,7 @@
 import io.avaje.http.api.Path;
 import io.avaje.http.api.Post;
 import io.avaje.http.api.Produces;
+import io.avaje.http.api.Put;
 import io.javalin.http.Context;
 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
 import io.swagger.v3.oas.annotations.info.Info;
@@ -78,4 +79,17 @@ Person testPostl(List<Person> m) {
 
     return new Person(0, "baby");
   }
+
+  @Put("/put")
+  @Produces(value = MediaType.TEXT_PLAIN, defaultStatus = 203)
+  @OpenAPIResponse(responseCode = "204", type = String.class)
+  String testDefaultStatus(Context ctx) {
+
+    if (ctx.contentType().equals(MediaType.APPLICATION_PDF)) {
+      ctx.status(204);
+      return "";
+    }
+
+    return "only partial info";
+  }
 }

tests/test-javalin-jsonb/src/test/resources/expectedOpenApi.json

@@ -132,8 +132,39 @@
         },
         "deprecated": true
       }
-    }
-  },
+    },
+		"/openapi/put" : {
+			"put" : {
+				"tags" : [
+
+				],
+				"summary" : "",
+				"description" : "",
+				"responses" : {
+					"204" : {
+						"description" : "",
+						"content" : {
+							"text/plain" : {
+								"schema" : {
+									"type" : "string"
+								}
+							}
+						}
+					},
+					"203" : {
+						"description" : "",
+						"content" : {
+							"text/plain" : {
+								"schema" : {
+									"type" : "string"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
   "components": {
     "schemas": {
       "ErrorResponse": {