Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#4,166 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
java
领域
api, backend

调研方向

从 org.apache.servicecomb.common.rest.codec.RestCodec#restToArgs 和 RestOperationMeta#init 开始，然后比较 issue 中展示的 CSE 1.X 和 2.X 类型创建路径。检查 Swagger @ApiImplicitParams allowableValues 及相关注解在 CSE 2.X 和 3.X 中是如何表示的。完成的标准是确定是否需要与 1.X 的验证兼容性，并确认类似注解是否会丢失 enum 信息。

由索引模型根据 Issue 内容生成。

描述

问题背景：

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

主要语言
Java
星标
1.9k
派生
813
平均合并
8 天 23 小时
30 天内合并 PR
1

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

apache/servicecomb-java-chassis 的其他 Issue

查看 apache/servicecomb-java-chassis 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。