首页 > 其他分享 >swagger常用的几个注解

swagger常用的几个注解

时间:2023-07-04 09:00:18浏览次数:33  
标签:常用 name tags true value 参数 注解 swagger 方法

类上@Api()

tags:说明该类的作用,参数是个数组,可以填多个。
value="该参数没什么意义,在UI界面上不显示,所以不用配置"
description = "用户基本信息操作"

方法上@ApiOperation()

value="方法的用途和作用"    
notes="方法的注意事项和备注"    
tags:说明该方法的作用,参数是个数组,可以填多个。
格式:tags={"作用1","作用2"} 

实体上@ApiModel()

description="描述实体的作用" 

属性上@ApiModelProperty

value="用户名"  描述参数的意义
name="name"    参数的变量名
required=true     参数是否必选

请求方法上@ApiImplicitParams

包含多@ApiImplicitParam
name="参数ming" 
value="参数说明" 
dataType="数据类型" 
paramType="query" 表示参数放在哪里
    · header 请求参数的获取:@RequestHeader
    · query   请求参数的获取:@RequestParam
    · path(用于restful接口) 请求参数的获取:@PathVariable
    · body(不常用)
    · form(不常用) 
defaultValue="参数的默认值"
required="true" 表示参数是否必须传

方法的参数字段说明@ApiParam()

name="参数名称"
value="参数的简要说明"
defaultValue="参数默认值"
required="true" 表示属性是否必填,默认为false

方法上响应码响应@ApiResponses

一个@ApiResponses包含多个@ApiResponse
code="404"    表示响应码(int型),可自定义
message="状态码对应的响应信息"   

不被显示@ApiIgnore()

用于类或者方法上,不被显示在页面上

环境@Profile({"dev", "test"})

用于配置类上,表示只对开发和测试环境有用

 

标签:常用,name,tags,true,value,参数,注解,swagger,方法
From: https://www.cnblogs.com/cgy-home/p/17524745.html

相关文章

  • cvs update 的输出标志/update常用几个参
    update和checkout在执行中,会为每个文件打印一行提示信息,文件的状态通过前面的单个字符指明:Ufile文件按要求从仓库得到更新。用在那些仓库里面有但你的工作目录没有的文件,以及工作目录里面没有修改过,但旧于仓库的文件。PfileU',但是cvs服务......
  • Java学习第一天 / 常用的DOS命令
     #盘符命令盘名+:#查看当前目录下多有文件dir#切换目录cd(changedirectory)#回上一个步骤cd..#清理屏幕cls(clearscreen)#退出终端exit#查看电脑IPipconfig#打开应用calcmspaintnotepad#ping命令ping+......
  • Java框架中常用的几种成熟的token生成框架对比
    Java框架中常用的几种成熟的token生成框架有:SpringSecurity:一个基于Spring的安全框架,提供了声明式的安全访问控制解决方案,支持多种认证和授权机制,如OAuth2.0、JWT等。ApacheShiro:一个轻量级的Java安全框架,提供了身份认证、授权、加密、会话管理等功能,支持多种数据源和缓存实......
  • 常用电话号码
    常用电话号码生活服务常用电话号码服务名称电话号码服务名称电话号码短信报警号码(部分城市开通)12110短信报警号码(部分城市开通)12110国际电话区号86国际电话区号86匪警台110匪警台110火警台119火警台119医疗急救台120医疗急救台120信息......
  • Unity Visual Studio 常用的自带配置以及快捷键
    ​完整文档->UnityVisualStudio常用的自带配置以及快捷键一、内联提示 不等号字体 快速创建新文件快捷键:Ctrl+shift+A 选择下一项与多行光标Alt+左键功能增强需安装插件Select Next Occurrence 拆分窗口窗口右上角 折叠大纲​......
  • oracle 中的常用exception
    1、异常的优点如果没有异常,在程序中,应当检查每个命令的成功还是失败,如BEGINSELECT...--checkfor’nodatafound’errorSELECT...--checkfor’nodatafound’errorSELECT...--checkfor’nodatafound’error这......
  • Java 常用注解@Configuration,@Bean及@ConfigurationProperties(prefix = "spring.data
    @ConfigurationpublicclassEventDataSourceConfig{@Bean(name="eventdataSource")@ConfigurationProperties(prefix="datasource.event")publicDataSourceoldDataSource(){returnDataSourceBuilder.create().build();......
  • linux 常用脚本
    启动python脚本并输出日志到文件nohuppython3-udoReport.py--env=prod>doReport.out2>&1&pip使用清华源pip3installscikit-learn-ihttps://pypi.tuna.tsinghua.edu.cn/simple......
  • 32. Spring Boot使用@SpringBootApplication注解【从零开始学Spring Boot】
     如果看了我之前的文章,这个节你就可以忽略了,这个是针对一些刚入门的选手存在的困惑进行写的一篇文章。很多SpringBoot开发者总是使用@Configuration,@EnableAutoConfiguration和@ComponentScan注解他们的main类。由于这些注解被如此频繁地一块使用(特别是你遵循以上最佳实践时),S......
  • git 开发常用命令
    git中的代码,整个的流程就是上图显示的那样,代码可能会经历最多4个地方会被推送到远程大致流程:clone克隆远程文件到本地=>通过编辑器编辑本地的代码(即在工作区)=>pull拉下远程的代码,可能有人提交代码到同分支=>add添加到暂存区=>commit提交到本地仓库=>push推送到......