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

Aberta

#4,166 aberta em 25/12/2023 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade: 4/5
Tempo estimado: 3-5 dias
Facilidade para iniciantes: 35/100

Tipo de issue: Bug
Clareza: Razoavelmente clara
Status de atividade: Estagnada
Stack de tecnologia: java
Domínio: api, backend

Direção de pesquisa

Comece por org.apache.servicecomb.common.rest.codec.RestCodec#restToArgs e RestOperationMeta#init e, em seguida, compare os caminhos de criação de tipos do CSE 1.X e 2.X mostrados no issue. Verifique como Swagger @ApiImplicitParams allowableValues e as anotações relacionadas são representados no CSE 2.X e 3.X. A tarefa estará concluída quando for determinado se a compatibilidade de validação com o 1.X é necessária e confirmado se anotações semelhantes perdem informações de enum.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

问题背景：

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

Linguagem predominante: Java
Estrelas: 1.9k
Forks: 813
Merge médio: 8d 23h
PRs com merge (30d): 1

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

Leia a issue inteira e depois o guia de contribuição do projeto.
Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
Faça um fork do repositório e trabalhe em uma branch.
Abra um pull request que referencie o número da issue.