improve response status writer (#339)

Author: hauner

src/main/kotlin/io/openapiprocessor/spring/processor/SpringFrameworkAnnotations.kt

@@ -46,7 +46,16 @@ class SpringFrameworkAnnotations: FrameworkAnnotations {
     }
 
     override fun getAnnotation(status: EndpointResponseStatus): Annotation {
-        return RESPONSE_STATUS_ANNOTATION
+        val statusCode = HTTP_STATUS[status.statusCode]
+        if (statusCode == null) {
+            log.error("unknown http status code: ${status.statusCode}")
+            return UNKNOWN_ANNOTATION
+        }
+
+        return Annotation(
+            getAnnotationName("ResponseStatus"),
+            linkedMapOf(
+                "code" to SimpleParameterValue(statusCode, HTTP_STATUS_ENUM)))
     }
 
     private fun getAnnotation(key: String): Annotation {
@@ -95,12 +104,6 @@ private val PARAMETER_ANNOTATIONS = hashMapOf(
     "body"            to Annotation (getAnnotationName("RequestBody"))
 )
 
-private val RESPONSE_STATUS_ANNOTATION = Annotation (
-    getAnnotationName("ResponseStatus"),
-    linkedMapOf("code" to SimpleParameterValue(
-        "HttpStatus", "org.springframework.http.HttpStatus"
-    )))
-
 private val UNKNOWN_ANNOTATION = Annotation("Unknown")
 
 private const val ANNOTATION_PKG = "org.springframework.web.bind.annotation"
@@ -113,3 +116,81 @@ private fun getMappingAnnotationName(mappingName: String): String {
 private fun getAnnotationName(name: String): String {
     return "${ANNOTATION_PKG}.${name}"
 }
+
+private val HTTP_STATUS = hashMapOf(
+    "100" to getEnum("CONTINUE"),
+    "101" to getEnum("SWITCHING_PROTOCOLS"),
+    "102" to getEnum("PROCESSING"), // WebDAV
+    "103" to getEnum("CHECKPOINT"),
+
+    "200" to getEnum("OK"),
+    "201" to getEnum("CREATED"),
+    "202" to getEnum("ACCEPTED"),
+    "203" to getEnum("NON_AUTHORITATIVE_INFORMATION"),
+    "204" to getEnum("NO_CONTENT"),
+    "205" to getEnum("RESET_CONTENT"),
+    "206" to getEnum("PARTIAL_CONTENT"),
+    "207" to getEnum("MULTI_STATUS"), // WebDAV
+    "208" to getEnum("ALREADY_REPORTED"), // WebDAV
+    "226" to getEnum("IM_USED"),
+
+    "300" to getEnum("MULTIPLE_CHOICES"),
+    "301" to getEnum("MOVED_PERMANENTLY"),
+    "302" to getEnum("FOUND"), // replaces MOVED_TEMPORARILY
+    "303" to getEnum("SEE_OTHER"),
+    "304" to getEnum("NOT_MODIFIED"),
+    "305" to getEnum("USE_PROXY"),
+    "307" to getEnum("TEMPORARY_REDIRECT"),
+    "308" to getEnum("PERMANENT_REDIRECT"),
+
+    "400" to getEnum("BAD_REQUEST"),
+    "401" to getEnum("UNAUTHORIZED"),
+    "402" to getEnum("PAYMENT_REQUIRED"),
+    "403" to getEnum("FORBIDDEN"),
+    "404" to getEnum("NOT_FOUND"),
+    "405" to getEnum("METHOD_NOT_ALLOWED"),
+    "406" to getEnum("NOT_ACCEPTABLE"),
+    "407" to getEnum("PROXY_AUTHENTICATION_REQUIRED"),
+    "408" to getEnum("REQUEST_TIMEOUT"),
+    "409" to getEnum("CONFLICT"),
+    "410" to getEnum("GONE"),
+    "411" to getEnum("LENGTH_REQUIRED"),
+    "412" to getEnum("PRECONDITION_FAILED"),
+    "413" to getEnum("PAYLOAD_TOO_LARGE"), // replaces REQUEST_ENTITY_TOO_LARGE
+    "414" to getEnum("URI_TOO_LONG"), // replaces REQUEST_URI_TOO_LONG
+    "415" to getEnum("UNSUPPORTED_MEDIA_TYPE"),
+    "416" to getEnum("REQUESTED_RANGE_NOT_SATISFIABLE"),
+    "417" to getEnum("EXPECTATION_FAILED"),
+    "418" to getEnum("I_AM_A_TEAPOT"),
+    "419" to getEnum("INSUFFICIENT_SPACE_ON_RESOURCE"), // WebDAV
+    "420" to getEnum("METHOD_FAILURE"), // WebDAV
+    "421" to getEnum("DESTINATION_LOCKED"), // WebDAV
+    "422" to getEnum("UNPROCESSABLE_ENTITY"), // WebDAV
+    "423" to getEnum("LOCKED"), // WebDAV
+    "424" to getEnum("FAILED_DEPENDENCY"), // WebDAV
+    "425" to getEnum("TOO_EARLY"),
+    "426" to getEnum("UPGRADE_REQUIRED"),
+    "428" to getEnum("PRECONDITION_REQUIRED"),
+    "429" to getEnum("TOO_MANY_REQUESTS"),
+    "431" to getEnum("REQUEST_HEADER_FIELDS_TOO_LARGE"),
+    "451" to getEnum("UNAVAILABLE_FOR_LEGAL_REASONS"),
+
+    "500" to getEnum("INTERNAL_SERVER_ERROR"),
+    "501" to getEnum("NOT_IMPLEMENTED"),
+    "502" to getEnum("BAD_GATEWAY"),
+    "503" to getEnum("SERVICE_UNAVAILABLE"),
+    "504" to getEnum("GATEWAY_TIMEOUT"),
+    "505" to getEnum("HTTP_VERSION_NOT_SUPPORTED"),
+    "506" to getEnum("VARIANT_ALSO_NEGOTIATES"),
+    "507" to getEnum("INSUFFICIENT_STORAGE"), // WebDAV
+    "508" to getEnum("LOOP_DETECTED"), // WebDAV
+    "509" to getEnum("BANDWIDTH_LIMIT_EXCEEDED"),
+    "510" to getEnum("NOT_EXTENDED"),
+    "511" to getEnum("NETWORK_AUTHENTICATION_REQUIRED")
+)
+
+private const val HTTP_STATUS_ENUM = "org.springframework.http.HttpStatus"
+
+private fun getEnum(name: String): String {
+    return "HttpStatus.${name}"
+}

src/main/kotlin/io/openapiprocessor/spring/writer/java/StatusAnnotationWriter.kt

@@ -24,12 +24,10 @@ class StatusAnnotationWriter(private val annotations: FrameworkAnnotations): Cor
 
     private fun createStatusAnnotation(status: EndpointResponseStatus): String {
         val data = annotations.getAnnotation(status)
-        val statusCode = status.statusCode.toInt()
+        val status = data.parameters["code"]
 
         var annotation = data.annotationName
-        annotation += "("
-        annotation += "HttpStatus.valueOf($statusCode)"
-        annotation += ")"
+        annotation += "(${status!!.value})"
         return annotation
     }
 }

src/test/kotlin/io/openapiprocessor/spring/processor/SpringFrameworkAnnotationsSpec.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-processor-spring
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.spring.processor
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.collections.shouldContainExactly
+import io.kotest.matchers.shouldBe
+import io.openapiprocessor.core.model.EndpointResponseStatus
+import io.openapiprocessor.core.model.HttpStatus
+
+
+class SpringFrameworkAnnotationsSpec : StringSpec({
+
+    class Status(override val statusCode: HttpStatus) : EndpointResponseStatus
+
+    "provides known HttpStatus annotation with specific status code import" {
+        val framework = SpringFrameworkAnnotations()
+
+        val annotation200 = framework.getAnnotation(Status("200"))
+        annotation200.referencedImports shouldContainExactly setOf("org.springframework.http.HttpStatus")
+        annotation200.parameters["code"]!!.value shouldBe "HttpStatus.OK"
+
+        val annotation400 = framework.getAnnotation(Status("400"))
+        annotation400.referencedImports shouldContainExactly setOf("org.springframework.http.HttpStatus")
+        annotation400.parameters["code"]!!.value shouldBe "HttpStatus.BAD_REQUEST"
+
+        val annotation500 = framework.getAnnotation(Status("500"))
+        annotation500.referencedImports shouldContainExactly setOf("org.springframework.http.HttpStatus")
+        annotation500.parameters["code"]!!.value shouldBe "HttpStatus.INTERNAL_SERVER_ERROR"
+    }
+})

src/test/kotlin/io/openapiprocessor/spring/writer/java/StatusAnnotationWriterSpec.kt

@@ -32,6 +32,6 @@ class StatusAnnotationWriterSpec: StringSpec({
 
         writer.write(target, ep, ep.endpointResponses.first())
 
-        target.toString() shouldBeEqual """@ResponseStatus(HttpStatus.valueOf(204))"""
+        target.toString() shouldBeEqual """@ResponseStatus(HttpStatus.NO_CONTENT)"""
     }
 })

src/testInt/resources/tests/response-status/outputs/api/Api.java

@@ -8,7 +8,7 @@
 @Generated(value = "openapi-processor-spring", version = "test")
 public interface Api {
 
-    @ResponseStatus(HttpStatus.valueOf(204))
+    @ResponseStatus(HttpStatus.NO_CONTENT)
     @GetMapping(path = "/foo")
     void getFoo();