write @ResponseStatus annotation (#339)

Author: hauner

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

@@ -8,6 +8,7 @@ package io.openapiprocessor.spring.processor
 import io.openapiprocessor.core.converter.mapping.SimpleParameterValue
 import io.openapiprocessor.core.framework.FrameworkAnnotations
 import io.openapiprocessor.core.model.Annotation
+import io.openapiprocessor.core.model.EndpointResponseStatus
 import io.openapiprocessor.core.model.RequestBody
 import io.openapiprocessor.core.model.parameters.CookieParameter
 import io.openapiprocessor.core.model.parameters.HeaderParameter
@@ -44,6 +45,10 @@ class SpringFrameworkAnnotations: FrameworkAnnotations {
         }
     }
 
+    override fun getAnnotation(status: EndpointResponseStatus): Annotation {
+        return RESPONSE_STATUS_ANNOTATION
+    }
+
     private fun getAnnotation(key: String): Annotation {
         return PARAMETER_ANNOTATIONS.getValue(key)
     }
@@ -90,6 +95,12 @@ 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"

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

@@ -15,6 +15,7 @@ import io.openapiprocessor.spring.Version
 import io.openapiprocessor.spring.writer.java.*
 import io.openapiprocessor.spring.writer.java.MappingAnnotationWriter
 import io.openapiprocessor.spring.writer.java.ParameterAnnotationWriter
+import io.openapiprocessor.spring.writer.java.StatusAnnotationWriter
 import io.openapiprocessor.test.api.OpenApiProcessorTest
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
@@ -64,6 +65,7 @@ class SpringProcessor : OpenApiProcessorTest {
                     MethodWriter(
                         options,
                         identifier,
+                        StatusAnnotationWriter(annotations),
                         MappingAnnotationWriter(annotations),
                         ParameterAnnotationWriter(annotations),
                         beanValidations,

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

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-processor-spring
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.spring.writer.java
+
+import io.openapiprocessor.core.framework.FrameworkAnnotations
+import io.openapiprocessor.core.model.Endpoint
+import io.openapiprocessor.core.model.EndpointResponse
+import io.openapiprocessor.core.model.EndpointResponseStatus
+import java.io.Writer
+import io.openapiprocessor.core.writer.java.StatusAnnotationWriter as CoreStatusAnnotationWriter
+
+class StatusAnnotationWriter(private val annotations: FrameworkAnnotations): CoreStatusAnnotationWriter {
+
+    override fun write(
+        target: Writer,
+        endpoint: Endpoint,
+        endpointResponse: EndpointResponse
+    ) {
+        target.write(createStatusAnnotation(endpointResponse))
+    }
+
+    private fun createStatusAnnotation(status: EndpointResponseStatus): String {
+        val data = annotations.getAnnotation(status)
+        val statusCode = status.statusCode.toInt()
+
+        var annotation = data.annotationName
+        annotation += "("
+        annotation += "HttpStatus.valueOf($statusCode)"
+        annotation += ")"
+        return annotation
+    }
+}

src/test/groovy/io/openapiprocessor/spring/writer/java/MethodWriterSpec.groovy

@@ -39,6 +39,7 @@ class MethodWriterSpec extends Specification {
     def writer = new MethodWriter (
         apiOptions,
         identifier,
+        new StatusAnnotationWriter(new SpringFrameworkAnnotations()),
         new MappingAnnotationWriter(new SpringFrameworkAnnotations()),
         new ParameterAnnotationWriter(new SpringFrameworkAnnotations()),
         new BeanValidationFactory (apiOptions),

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-processor-spring
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.spring.writer.java
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.equals.shouldBeEqual
+import io.openapiprocessor.core.model.Endpoint
+import io.openapiprocessor.core.model.Response
+import io.openapiprocessor.core.model.datatypes.NoneDataType
+import io.openapiprocessor.core.parser.HttpMethod
+import io.openapiprocessor.spring.processor.SpringFrameworkAnnotations
+import java.io.StringWriter
+
+
+class StatusAnnotationWriterSpec: StringSpec({
+    val writer = StatusAnnotationWriter(SpringFrameworkAnnotations())
+    val target = StringWriter()
+
+    "write response status annotation" {
+        val ep = Endpoint(
+            "/foo",
+            HttpMethod.GET,
+            emptyList(),
+            emptyList(),
+            mapOf(
+                "204" to listOf(Response("?", NoneDataType()))
+            )
+        )
+
+        writer.write(target, ep, ep.endpointResponses.first())
+
+        target.toString() shouldBeEqual """@ResponseStatus(HttpStatus.valueOf(204))"""
+    }
+})

src/testInt/kotlin/io/openapiprocessor/spring/ProcessorTestSets.kt

@@ -6,6 +6,7 @@
 package io.openapiprocessor.spring
 
 import io.openapiprocessor.test.*
+import io.openapiprocessor.test.test30_D_
 
 data class TestSet(val name: String, val openapi: String)
 
@@ -18,7 +19,8 @@ val ALL_30: List<TestParams> = listOf(
     test30_D_("params-query-annotate-simple-mapping"),
     test30_DR("params-request-body"),
     test30_D_("params-request-body-multipart-mapping"),
-    test30_D_("params-simple-data-types")
+    test30_D_("params-simple-data-types"),
+    test30_D_("response-status")
 )
 
 val ALL_31: List<TestParams> = listOf(
@@ -30,5 +32,6 @@ val ALL_31: List<TestParams> = listOf(
     test31_D_("params-query-annotate-simple-mapping"),
     test31_DR("params-request-body"),
     test31_DR("params-request-body-multipart-mapping"),
-    test31_D_("params-simple-data-types")
+    test31_D_("params-simple-data-types"),
+    test31_D_("response-status")
 )

src/testInt/resources/tests/response-status/inputs.yaml

@@ -0,0 +1,5 @@
+prefix: api
+items:
+  - inputs/openapi30.yaml
+  - inputs/openapi31.yaml
+  - inputs/mapping.yaml

src/testInt/resources/tests/response-status/inputs/mapping.yaml

@@ -0,0 +1,9 @@
+openapi-processor-mapping: v13
+
+options:
+  package-name: generated
+  format-code: false
+
+map:
+  result-style: success
+  result-status: true

src/testInt/resources/tests/response-status/inputs/openapi30.yaml

@@ -0,0 +1,12 @@
+openapi: 3.0.2
+info:
+  title: response status
+  version: 1.0.0
+
+paths:
+
+  /foo:
+    get:
+      responses:
+        '204':
+          description: empty

src/testInt/resources/tests/response-status/inputs/openapi31.yaml

@@ -0,0 +1,12 @@
+openapi: 3.1.0
+info:
+  title: response status
+  version: 1.0.0
+
+paths:
+
+  /foo:
+    get:
+      responses:
+        '204':
+          description: empty

src/testInt/resources/tests/response-status/outputs.yaml

@@ -0,0 +1,3 @@
+prefix: generated
+items:
+  - outputs/api/Api.java

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

@@ -0,0 +1,15 @@
+package generated.api;
+
+import generated.support.Generated;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@Generated(value = "openapi-processor-spring", version = "test")
+public interface Api {
+
+    @ResponseStatus(HttpStatus.valueOf(204))
+    @GetMapping(path = "/foo")
+    void getFoo();
+
+}