首页 > 其他分享 >SpringBoot集成Swagger3之二:Swagger3注解使用说明

SpringBoot集成Swagger3之二:Swagger3注解使用说明

时间:2024-12-20 10:23:45浏览次数:3  
标签:请求 之二 说明 响应 参数 注解 Swagger3 SpringBoot

@Api:用在请求的类上,表示对类的说明
    tags="说明该类的作用,可以在UI界面上看到的注解"
    value="该参数没什么意义,在UI界面上也看到,所以不需要配置"

@ApiOperation:用在请求的方法上,说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams:用在请求的方法上,表示一组参数说明
    @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
        name:参数名
        value:参数的汉字说明、解释
        required:参数是否必须传
        paramType:参数放在哪个地方
            · header --> 请求参数的获取:@RequestHeader
            · query --> 请求参数的获取:@RequestParam
            · path(用于restful接口)--> 请求参数的获取:@PathVariable
            · body(不常用)
            · form(不常用)    
        dataType:参数类型,默认String,其它值dataType="Integer"       
        defaultValue:参数的默认值

@ApiResponses:用在请求的方法上,表示一组响应
    @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
        code:数字,例如400
        message:信息,例如"请求参数没填好"
        response:抛出异常的类

@ApiModel:用于响应类上,表示一个返回响应数据的信息
            (这种一般用在post创建的时候,使用@RequestBody这样的场景,
            请求参数无法使用@ApiImplicitParam注解进行描述的时候)
    @ApiModelProperty:用在属性上,描述响应类的属性

标签:请求,之二,说明,响应,参数,注解,Swagger3,SpringBoot
From: https://www.cnblogs.com/dtx123/p/15675553.html

相关文章

  • springboot447教师薪酬管理系统(论文+源码)_kaic
     摘   要传统信息的管理大部分依赖于管理人员的手工登记与管理,然而,随着近些年信息技术的迅猛发展,让许多比较老套的信息管理模式进行了更新迭代,老师信息因为其管理内容繁杂,管理数量繁多导致手工进行处理不能满足广大用户的需求,因此就应运而生出相应的教师薪酬管理系统。......
  • springboot446数字化农家乐管理平台的设计与实现(论文+源码)_kaic
     摘 要互联网发展至今,无论是其理论还是技术都已经成熟,而且它广泛参与在社会中的方方面面。它让信息都可以通过网络传播,搭配信息管理工具可以很好地为人们提供服务。针对信息管理混乱,出错率高,信息安全性差,劳动强度大,费时费力等问题,采用数字化农家乐管理平台可以有效管理,使信......
  • springboot445新冠物资管理(论文+源码)_kaic
     摘 要使用旧方法对新冠物资管理的信息进行系统化管理已经不再让人们信赖了,把现在的网络信息技术运用在新冠物资管理的管理上面可以解决许多信息管理上面的难题,比如处理数据时间很长,数据存在错误不能及时纠正等问题。这次开发的新冠物资管理对字典管理、论坛管理、疫情公告......
  • SpringBoot3整合FastJSON2如何配置configureMessageConverters
    在SpringBoot3中整合FastJSON2主要涉及到以下几个步骤,包括添加依赖、配置FastJSON作为JSON处理器等。下面是详细的步骤:1.添加依赖首先,你需要在你的pom.xml文件中添加FastJSON2的依赖。以下是Maven依赖的示例:<!--https://mvnrepository.com/artifact/com......
  • 基于springboot+vue的计算机岗位推荐招聘系统设计与实现
    ......
  • 基于springboot+vue的智慧景区管理系统的设计与实现
    ......
  • 基于Java+SpringBoot的智慧草莓基地管理系统
    关注底部领取源码源码编号:S386源码名称:基于SpringBoot的智慧草莓基地管理系统用户类型:双角色,用户、管理员主要技术:Java、Vue、ElementUl、SpringBoot运行环境:Windows/Mac、JDK1.8及以上运行工具:IDEA/Eclipse数 据 库:MySQL5.7及以上版本数据库表数量:16张表是否有......
  • springboot毕设 旅行景点推荐系统程序+论文
    系统程序文件列表开题报告内容研究背景随着人们生活水平的提高和旅游观念的普及,旅行已成为现代人休闲娱乐的重要方式之一。然而,面对海量的旅游信息和景点选择,游客往往感到无所适从,难以找到符合自己兴趣和需求的旅行景点。因此,构建一个智能化、个性化的旅行景点推荐系统显得......
  • springboot毕设 旅游助手系统程序+论文
    系统程序文件列表开题报告内容研究背景随着旅游业的蓬勃发展,人们对旅游服务的需求日益多样化与个性化。传统的旅游服务模式已难以满足现代人对于便捷性、全面性和个性化服务的追求。在这一背景下,旅游助手系统的开发应运而生。该系统旨在整合各类旅游资源,通过智能化的手段为......
  • springboot毕设 志愿者服务管理系统 程序+论文
    本系统(程序+源码)带文档lw万字以上文末可获取一份本项目的java源码和数据库参考。系统程序文件列表开题报告内容研究背景在当今社会,志愿者服务已成为推动社会进步、弘扬正能量的重要力量。随着志愿服务的普及和深入,志愿者队伍日益壮大,志愿服务活动形式也日益多样化。然而,......