swagger中参数为数组dataType的设置

最新推荐文章于 2025-03-25 10:39:13 发布

垂天丶翼

最新推荐文章于 2025-03-25 10:39:13 发布

阅读量2.3w

点赞数 7

分类专栏： Java 学习文章标签： java swagger

本文链接：https://blog.youkuaiyun.com/qq_39393671/article/details/103307690

版权

学习同时被 2 个专栏收录

4 篇文章

订阅专栏

Java

3 篇文章

订阅专栏

本文详细解析了Swagger接口参数的使用，包括Swagge接口参数的设置方法，如@Id、@useridlist、@Authorization的使用场景及含义，参数类型dataType的解释，参数位置paramType的说明，以及如何在代码中通过不同注解接收这些参数。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. Swagge 接口参数：

@ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "项目ID", dataType = "String", paramType = "query", required = true),
        @ApiImplicitParam(name = "useridlist", value = "用户ID数组", dataType = "String", paramType = "body", allowMultiple = true, required = true ),
        @ApiImplicitParam(name = "Authorization", value = "身份验证Token", dataType = "String", paramType = "header"),
})

allowMultiple=true————表示是数组格式的参数 
dataType="body"————表示数组中参数的类型

dataType="String" 代表请求参数类型为String类型，当然也可以是Map、User、int等；
paramType="body" 代表参数应该放在请求的什么地方：

    header-->放在请求头。请求参数的获取：@RequestHeader(代码中接收注解)
    query -->用于get请求的参数拼接。请求参数的获取：@RequestParam(代码中接收注解)
    path  -->（用于restful接口）-->请求参数的获取：@PathVariable(代码中接收注解)
    body  -->放在请求体。请求参数的获取：@RequestBody(代码中接收注解)
    form  -->（不常用）

2. 界面效果：

3. swagger 传参：

list数组：

List : ["string","string","string"]

4. 接收参数

    header-->放在请求头。请求参数的获取：@RequestHeader(代码中接收注解)
    query-->用于get请求的参数拼接。请求参数的获取：@RequestParam(代码中接收注解)
    path（用于restful接口）-->请求参数的获取：@PathVariable(代码中接收注解)
    body-->放在请求体。请求参数的获取：@RequestBody(代码中接收注解)
    form（不常用）

     @RequestHeader(required = false)： 解决不传参数时接口报错的问题