首页 > 其他分享 >spring boot Swagger2(version=2.7.0) 注解@ApiImplicitParam的属性dataType值为”自定义泛型“应用

spring boot Swagger2(version=2.7.0) 注解@ApiImplicitParam的属性dataType值为”自定义泛型“应用

时间:2022-11-08 15:24:45浏览次数:54  
标签:ApiImplicitParam 自定义 dataType value 参数 泛型 GenericType

转载自:https://www.bbsmax.com/A/WpdKlbDqzV/

注解:

@ApiImplicitParams

@ApiImplicitParam  

 name="需注解的API输入参数",

value="接收参数的意义描述",

paramType="参数存放位置",

dataType="参数类型,可传基本类型、类、泛型类等",

required="输入参数是否必传"

其它属性暂时忽略,具体可查看官网等资源。

敲重点:属性“dataType”基本类型、类按照正常来赋值,自定义泛型类应该按照如下格式来赋值:

例如:dataType = "demo«ArrayList«demo1»»",重点是符号“«»”。

以下摘自swagger2源码(各位看官请自行体会):

fieldName

typeName

qualifiedTypeName

genericByteArray

GenericType«Array«byte»»

springfox.documentation.schema.GenericType<byte[]>

genericCategoryArray

GenericType«Array«Category»»

springfox.documentation.schema.GenericType<springfox.documentation.schema.Category[]>

示例:

@ApiImplicitParams(value = {@ApiImplicitParam(name = "input", value = "接收参数的意义描述", paramType = "body", dataType = "demo«ArrayList«demo1»»", required = true), @ApiImplicitParam(name = "index", value = "接收参数的意义描述", paramType = "query", dataType = "String", required = true)})

效果图:

 

标签:ApiImplicitParam,自定义,dataType,value,参数,泛型,GenericType
From: https://www.cnblogs.com/zhncnblogs/p/16869805.html

相关文章

  • @ApiImplicitParam注解的dataType、paramType两个属性的区别?
    dataType="int"代表请求参数类型为int类型,当然也可以是Map、User、String等;paramType="body"代表参数应该放在请求的什么地方:  header-->放在请求头。请求参数的......
  • 写过vue自定义指令吗,原理是什么?.m
    背景看了一些自定义指令的文章,但是探究其原理的文章却不多见,所以我决定水一篇。如何自定义指令?其实关于这个问题官方文档上已经有了很好的示例的,我们先来温故一下。除......
  • uniapp不使用自定义tabbar的情况下隐藏指定的tabbar
    uni给提供的api中uni.hideTabBar()是控制所有的tabbar显示和隐藏,并不能达到我们想要的效果图,但是我仔细看过文档后发现uni.setTabBarItem()中有visible这个选项控......
  • 微信小程序自定义顶部导航
    一、设置自定义顶部导航Navigation是小程序的顶部导航组件,当页面配置navigationStyle设置为custom的时候可以使用此组件替代原生导航栏。1.全局顶部导航自定义,在......
  • 小程序自定义组件以及页面之间的数据传递
    1、自定义组件接收页面传递过来的数据首先在组件的属性列表properties中设置数据类型以及默认值,然后再在引用组件的页面上设置相应的接收数据的名字以及数据内容(跟小程序......
  • 创建vue自定义指令
    title:创建自定义指令在组件标签的使用中,我们经常使用一些指令,例如v-for/v-model,在这里我们学习一下如何实现一个自定义指令,如何写一个自己想要实现的自定义指令功能,最......
  • SQL自定义函数
     存储函数和存储过程统称为存储例程(storeroutine),存储函数的限制比较多,例如不能用临时表,只能用表变量,而存储过程的限制较少,存储过程的实现功能要复杂些,而函数的......
  • MySQL自定义函数
    首先,做一个热身。引进一个系统函数LAST_INSERT_ID();这个函数的功能就是放回上一次插入的数据的id做个示范插入数据                       ......
  • Springboot 自定义mybatis 拦截器,实现我们要的扩展
    前言相信大家对拦截器并不陌生,对mybatis也不陌生。有用过pagehelper的,那么对mybatis拦截器也不陌生了,按照使用的规则触发sql拦截,帮我们自动添加分页参数。那么今天,我们的实......
  • 【前端开发】如何将vue组件转成自定义指令使用,(在自定义指令中使用element ui组件或常
    //导入组件importVuefrom'vue'importXxTipsfrom'packages/basic/xx-tips/src/XxTips.vue'//自定义指令Vue.directive('tip',{bind(el,binding){el.......