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

Aperta

#4,166 aperta il 25/12/2023 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà: 4/5
Tempo stimato: 3-5 giorni
Idoneità per principianti: 35/100

Tipo di issue: Bug
Chiarezza: Abbastanza chiara
Stato di attività: Ferma
Stack tecnologico: java
Ambito: api, backend

Direzione di ricerca

Iniziare da org.apache.servicecomb.common.rest.codec.RestCodec#restToArgs e RestOperationMeta#init, quindi confrontare i percorsi di creazione dei tipi di CSE 1.X e 2.X mostrati nell’issue. Verificare come Swagger @ApiImplicitParams allowableValues e le annotazioni correlate sono rappresentati in CSE 2.X e 3.X. Il lavoro è completato quando si determina se è richiesta la compatibilità di validazione con 1.X e si conferma se annotazioni simili perdono le informazioni sull’enum.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

问题背景：

从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保持兼容以及其他类似注解是否有相同问题

Lingua principale: Java
Stelle: 1.9k
Fork: 813
Merge medio: 8g 23h
PR unite (30g): 1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

Leggi tutta la issue e poi la guida ai contributi del progetto.
Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
Fai un fork del repository e lavora su un branch.
Apri una pull request che faccia riferimento al numero della issue.