Spring: support OpenAPI 3.2 `query` operations (HTTP QUERY, RFC 10008)
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 76/100
Línea de trabajo
Empieza en SpringFrameworkAnnotations.kt en MAPPING_ANNOTATIONS y compara las entradas existentes HEAD/OPTIONS/TRACE con el mapping RequestMethod.QUERY propuesto en el issue; ten en cuenta que la búsqueda también se ejecuta durante la recolección de imports, por lo que exclude: true sigue fallando. Añade la entrada, luego ejecuta las pruebas unitarias del procesador para las anotaciones de Spring y regenera una spec de ejemplo que contenga una operación query para confirmar la salida de @RequestMapping(method = RequestMethod.QUERY). Hecho significa que una spec query se procesa correctamente y que los métodos personalizados desconocidos fallan con un mensaje claro en lugar de con una NoSuchElementException.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description
openapi-processor-base 2025.6 added parser support for OpenAPI 3.2 query and custom
http methods (openapi-processor-base#313). However, openapi-processor-spring fails as soon
as the spec contains a query operation, because SpringFrameworkAnnotations has no
mapping annotation for HttpMethod.QUERY.
Spring Framework 7.1 (Spring Boot 4.2) now supports QUERY natively via
RequestMethod.QUERY / HttpMethod.QUERY, so the generated interface could use
@RequestMapping(method = RequestMethod.QUERY).
Versions
- openapi-processor-spring: 2026.3.2 (latest release)
- openapi-processor gradle plugin: 2026.2
- Gradle 9.7.1, Java 25
Steps to reproduce
openapi/openapi.yaml:
openapi: 3.2.0
info:
title: query sample
version: 1.0.0
paths:
/products:
query:
operationId: queryProducts
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProductSearchCriteria'
responses:
'200':
description: matching products
content:
application/json:
schema:
type: array
items:
type: string
components:
schemas:
ProductSearchCriteria:
type: object
properties:
keyword:
type: string
openapi/mapping.yaml:
openapi-processor-mapping: v17
options:
package-name: com.example.api
Run ./gradlew processSpring.
Actual result
processing failed!
java.util.NoSuchElementException: Key QUERY is missing in the map.
at io.openapiprocessor.spring.processor.SpringFrameworkAnnotations.getAnnotation(SpringFrameworkAnnotations.kt:32)
at io.openapiprocessor.core.writer.java.InterfaceWriter.collectImports(InterfaceWriter.kt:59)
at io.openapiprocessor.core.writer.java.InterfaceWriter.write(InterfaceWriter.kt:33)
at io.openapiprocessor.core.writer.java.ApiWriter.writeInterface(ApiWriter.kt:114)
...
Excluding the endpoint in mapping.yaml gives the same error:
map:
paths:
/products:
query:
exclude: true
Changing only query: to post: in the same spec generates code successfully:
@PostMapping(path = "/products", consumes = {"application/json"}, produces = {"application/json"})
String[] queryProducts(@RequestBody ProductSearchCriteria body);
As a result, a spec that contains any query operation cannot be processed at all.
Expected result
Something like the following, analogous to how HEAD/OPTIONS/TRACE are generated today:
@RequestMapping(path = "/products", method = RequestMethod.QUERY, consumes = {"application/json"}, produces = {"application/json"})
String[] queryProducts(@RequestBody ProductSearchCriteria body);
Possible fix
Add an entry to MAPPING_ANNOTATIONS in SpringFrameworkAnnotations.kt:
HttpMethod.QUERY to Annotation(getMappingAnnotationName("request"), linkedMapOf(
"method" to SimpleParameterValue("RequestMethod.QUERY", ANNOTATION_REQUEST_METHOD))
),
Notes:
RequestMethod.QUERYexists only in Spring Framework 7.1+. Generated code for a spec
withqueryoperations would therefore require Spring 7.1. This seems acceptable, since
such a spec cannot be implemented on older Spring versions anyway, but it may be worth
documenting.- Custom methods from
additionalOperations(e.g.COPY) cannot be expressed with Spring's
RequestMethodenum. A clear error message (or skipping them with a warning) would be
better than aNoSuchElementException. - Spring 7.1 does not (yet) provide a
@QueryMappingshortcut annotation, so
@RequestMapping(method = RequestMethod.QUERY)is the way to declare it.
I verified on Spring Boot 4.2.0 with embedded Tomcat 11 that a hand-written controller
using @RequestMapping(method = RequestMethod.QUERY) works, including JSON and form-urlencoded
request bodies. The generated interface should work the same way.
- Lenguaje dominante
- Kotlin
- Estrellas
- 56
- Forks
- 11
- Merge medio
- 4 d 10 h
- PR fusionados (30 d)
- 8
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openapi-processor/openapi-processor-spring
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
openapi-processor/openapi-processor-spring#334 · 2 comentarios ·
Los mantenedores suelen responder en 2 días
-
Inheritance supportAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
openapi-processor/openapi-processor-spring#159 · 1 comentario ·
Los mantenedores suelen responder en 2 días
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 42/100
openapi-processor/openapi-processor-spring#150 · 3 comentarios ·
Los mantenedores suelen responder en 2 días
-
undecided
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
openapi-processor/openapi-processor-spring#101 · 1 comentario ·
Los mantenedores suelen responder en 2 días
-
log unknown optionsAbiertoenhancement undecided
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
openapi-processor/openapi-processor-spring#51 ·
Los mantenedores suelen responder en 2 días
Todos los issues de openapi-processor/openapi-processor-spring
Issues similares
-
help wanted needs investigation priority: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
LeanBitLab/LeanType#883 ·
Los mantenedores suelen responder en 1 día
-
Heavy legs 1.12–1.17: compiler corpus goldens not regenerated for #4770Posiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
intellij-elixir/intellij-elixir#4782 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
komikku-app/komikku#1983 ·
Los mantenedores suelen responder en 1 día
-
ERR_CLEARTEXT_NOT_PERMITTEDAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Seb3thehacker/gearslip#121 ·