swagger2 注解说明 ( @ApiImplicitParams )

swagger2 注解说明 ( @ApiImplicitParams )Api 用在请求的类上 表示对类的说明 tags 说明该类的作用 可以在 UI 界面上看到的注解 value 该参数没什么意义 在 UI 界面上也看到 所以不需要配置 ApiOperation 用在请求的方法上 说明方法的用途 作用 value 说明方法的用途 作用 notes 方法的备注说明 ApiImplicitP 用在请求的方

 

 前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家。点击跳转到教程。

@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:用在属性上,描述响应类的属性
@Api(tags="APP用户注册Controller")
@ApiOperation(value="用户注册",notes="手机号、密码都是必输项,年龄随边填,但必须是数字")

示列:

@ApiImplicitParams({     @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),     @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),     @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer") })
@ApiOperation(value = "select1请求",notes = "多个参数,多种的查询参数类型") @ApiResponses({     @ApiResponse(code=400,message="请求参数没填好"),     @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") })
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @ApiModel(description= "返回响应数据") public class RestMessage implements Serializable{     @ApiModelProperty(value = "是否成功")     private boolean success=true;     @ApiModelProperty(value = "返回对象")     private Object data;     @ApiModelProperty(value = "错误编号")     private Integer errCode;     @ApiModelProperty(value = "错误信息")     private String message;     /* getter/setter */ }

 

 

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/231688.html原文链接:https://javaforall.net

(0)
上一篇 2025年11月27日 上午11:01
下一篇 2025年11月27日 上午11:22


相关推荐

  • hive数据库数据类型_hive decimal类型

    hive数据库数据类型_hive decimal类型下面介绍几种常用的数据类(1)CHAR()该数据类型用于定义固定长度的字符串,其中用于指定字符串的最大长度,必须是正整数且不超过32767。使用CHAR类型定义变量时,如果没有指定则默认值为1。需要注意的是,在PL/SQL块中,使用该数据类型操纵CHAR表列时,其数值的长度不应超过2000字节。(2)VARCHAR2()该数据类型用于定义可变长度的字符串,其中用于指定字符串的最大长度,必须是正整数且不超过32767。使用VARCHAR2类型定义变量时,必须指定的值。需要注意的是,在P…

    2026年2月5日
    4
  • .net AutoEventWireup介绍

    .net AutoEventWireup介绍ASP.NET页会引发诸如Init、Load、PreRender等生命周期事件。默认情况下,可以使用Page_事件名称的命名约定将页事件绑定到方法。例如,若要为页的Load事件创建处理程序,可以创建名为P…

    2022年5月28日
    36
  • Anaconda安装opencv3.4.3

    Anaconda安装opencv3.4.3因为项目需要 安装 opencv3 4 3 版本进行实验测试在 Anaconda 的指定环境终端中 输入 pipinstallop contrib python 3 4 3 会报错啊哈 提示 只要换成想要版本的指定形式就行 比如我想装 3 4 3 版本 就重新输入 pipinstallop contrib python 3 4 3 18 之前在 Anaconda 用 condainstall 3 4 3 行不通哈 通过 Navigator 也安装不了指定的版本 只能是最新版

    2026年3月26日
    2
  • 项目管理和主观能动性

    项目管理和主观能动性项目管理

    2026年3月19日
    2
  • 第二届全国大学生网络安全精英赛初赛错题笔记

    第二届全国大学生网络安全精英赛初赛错题笔记(一)1.通信保密阶段主要威胁:搭线窃听和密码分析主要措施:数据加密保护机密性和完整性开始标志:香农的《保密系统的信息理论》2.信息安全的阶段四个阶段:通信安全、计算机安全、信息安全、信息保障3.信息系统安全保障蕴含:生命周期、保障要素、安全特征4.完整性:确保信息在存储、使用、传输的过程中不会被非授权按用户篡改,同时还要防止授权用户对信息进行不恰当篡改,保持信息内外部表示的一致性国际标准化组织:IOS/OSI提供了五种安全服务:以及八类安全机制。五类安全服务:认证(鉴别)服

    2022年5月25日
    59
  • MySQL配置允许远程连接

    MySQL默认在本地loaclhost登录root用户,然而远程连接却会报错(root@1X.X.X.Xacessdenied)。这里就需要进行配置允许远程连接才行,配置方法如下:打开cmd,输入命令,登录数据库:”mysql-uroot-p”,输入数据库登录密码:2.输入授权命令:”grantallprivilegeso…

    2022年4月9日
    38

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号