Swagger @ApiModelProperty 注解的解析类 ApiModelPropertyPropertyBuilder

swagger版本:3.0
由于之前项目采用@ApiModelProperty对响应属性进行说明,但是由于dataType的属性不规范,造成了swagger中的类型说明为object,所以跟踪了一下swagger的注解解析过程。

ApiModelPropertyPropertyBuilder.class关键代码

public void apply(ModelPropertyContext context) {
    Optional<ApiModelProperty> annotation = empty();

    if (context.getAnnotatedElement().isPresent()) {
      annotation =
          annotation.map(Optional::of)
                    .orElse(findApiModePropertyAnnotation(context.getAnnotatedElement().get()));
    }
    if (context.getBeanPropertyDefinition().isPresent()) {
      annotation = annotation.map(Optional::of).orElse(findPropertyAnnotation(
          context.getBeanPropertyDefinition().get(),
          ApiModelProperty.class));
    }
    if (annotation.isPresent()) {
      ModelSpecification modelSpecification =
          annotation.map(a -> {
            if (!a.dataType().isEmpty()) {
              // 关注点1:
              return modelSpecifications.create(context.getOwner(), toType(context.getResolver()).apply(a));
            }
            return null;
          })
          .orElse(null);
      Optional<ApiModelProperty> finalAnnotation = annotation;
      context.getSpecificationBuilder()
             .description(annotation.map(toDescription(descriptions)).orElse(null))
             .readOnly(annotation.map(ApiModelProperty::readOnly).orElse(false))
             .isHidden(annotation.map(ApiModelProperty::hidden).orElse(false))
             //注意此处修改了Type属性
             .type(modelSpecification)
             .position(annotation.map(ApiModelProperty::position).orElse(0))
             .required(annotation.map(ApiModelProperty::required).orElse(false))
             .example(annotation.map(toExample()).orElse(null))
             .enumerationFacet(e -> e.allowedValues(finalAnnotation.map(toAllowableValues()).orElse(null)));

      context.getBuilder()
             .allowableValues(annotation.map(toAllowableValues()).orElse(null))
             .required(annotation.map(ApiModelProperty::required).orElse(false))
             .readOnly(annotation.map(ApiModelProperty::readOnly).orElse(false))
             .description(annotation.map(toDescription(descriptions)).orElse(null))
             .isHidden(annotation.map(ApiModelProperty::hidden).orElse(false))
             .type(annotation.map(toType(context.getResolver())).orElse(null))
             .position(annotation.map(ApiModelProperty::position).orElse(0))
             .example(annotation.map(toExample()).orElse(null));
    }
  }

ApiModelProperties.class 关键代码2

static Function<ApiModelProperty, ResolvedType> toType(final TypeResolver resolver) {
    return annotation -> {
      try {
      //ApiModelProperty  的dataType 只能写 全局限域名
        return resolver.resolve(Class.forName(annotation.dataType()));
      } catch (ClassNotFoundException e) {
       // 如果找不到类对象,则会被覆盖为Object类型
        return resolver.resolve(Object.class);
      }
    };
  }

建议 @ApiModelProperty 注解的dataType不写,采用swagger默认的属性说明

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351

推荐阅读更多精彩内容