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"})
用于配置类上,表示只对开发和测试环境有用
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· DeepSeek 开源周回顾「GitHub 热点速览」
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
· AI与.NET技术实操系列(二):开始使用ML.NET
· .NET10 - 预览版1新功能体验(一)
2022-07-04 docker创建redis集群并从rdm连接虚拟机中redis
2022-07-04 Docker容器中端口号被占用解决和容器被占用和修改端口号
2022-07-04 解决虚拟机中doker容器拉取镜像失败的问题
2019-07-04 8.3-构造器调用顺序