从CSE 1.X 升级到 CSE 2.X后，接口配置的swagger注解@ApiImplicitParams 参数失效

Offen

#4,166 erstellt am 25.12.2023 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java
Bereich: api, backend

Rechercherichtung

Beginnen Sie bei org.apache.servicecomb.common.rest.codec.RestCodec#restToArgs und RestOperationMeta#init und vergleichen Sie anschließend die im Issue gezeigten Pfade zur Typ-Erstellung in CSE 1.X und 2.X. Prüfen Sie, wie Swagger @ApiImplicitParams allowableValues und verwandte Annotationen in CSE 2.X und 3.X dargestellt werden. Die Aufgabe ist abgeschlossen, wenn festgestellt wurde, ob die Validierungskompatibilität mit 1.X erforderlich ist, und bestätigt wurde, ob ähnliche Annotationen Enum-Informationen verlieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

问题背景：

从CSE 1.X 升级到 CSE 2.X后，接口配置的swagger注解@ApiImplicitParams 参数失效
接口定义如下：

@RequestMapping(path = "/v1/test", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
    @ApiImplicitParams(value = {
        @ApiImplicitParam(name = "x-test-header", dataType = "string", required = false,
            paramType = "header", value = "xxx",
            allowableValues = "true,false")})
    public String testV1(HttpServletRequest request) {
        return "ok";
    }

使用CSE 1.X时，如果传入的header不是true或者false，报错如下：

{
    "message": "Parameter is not valid for operation [XXX.XXX.testV1]. Parameter is [x-test-header]. Processor is [header]."
}

使用CSE 3.X时，接口无报错

问题分析：

通过对比CSE 1.X和2.X的代码，发现org.apache.servicecomb.common.rest.codec.RestCodec#restToArgs将request请求转发为请求对象的过程中，org.apache.servicecomb.common.rest.definition.RestOperationMeta#init中创建Type的代码进行了调整
从

    Method method = operationMeta.getMethod();
    Type[] genericParamTypes = method.getGenericParameterTypes();

调整为

(Type)operationMeta.getSwaggerProducerOperation().getSwaggerParameterTypes().get(parameter.getName())

导致type丢失了枚举信息

请帮忙确认是否需要跟CSE 1.X保持兼容以及其他类似注解是否有相同问题

Vorherrschende Sprache: Java
Sterne: 1.9k
Forks: 813
Ø Merge: 8 T. 23 Std.
Gemergte PRs (30 T.): 1

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus apache/servicecomb-java-chassis

[SECURITY] - 依赖软件 org.apache.tomcat.embed:tomcat-embed-core:jar:10.1.40 有安全漏洞 bug Offen

bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

apache/servicecomb-java-chassis#5106 · Erstellt am 24.3.2026
[QUESTION] - Java Chassis 3 的 ssl.[tag].[property] tag是否支持接口级配置 Offen

question

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

apache/servicecomb-java-chassis#5153 · 1 Kommentar · Erstellt am 07.8.2026
[QUESTION] - 请发布3.x的最新版本 Offen

question

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100

apache/servicecomb-java-chassis#5146 · Erstellt am 04.6.2026
[FEATURE] - When will ServiceComb support Spring Boot 4.x, Spring Framework 7.x, and Jackson 3.x? Offen

enhancement

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

apache/servicecomb-java-chassis#5145 · Erstellt am 03.6.2026
[BUG] - The latest instance information cannot be obtained when cache instances is empty. Offen

2.x bug

apache/servicecomb-java-chassis#5141 · 1 zugewiesene Person · Erstellt am 19.5.2026

Alle Issues in apache/servicecomb-java-chassis