swagger2注解说明文档

注解	属性	说明
@Api		用于类上，说明该类的作用。可以标记一个controller类作为swagger的文档资源
	value	url的路径
	tags	如果设置这个值，value的值会被覆盖
	description	对Api资源的描述
	basePath	基本路径，可以不用配置
	position	设置多个Api显示的顺序位置
	produces	For example, “application/json, application/xml”
	consumes	For example, “application/json, application/xml”
	protocols	Possible values: http, https, ws, wss.
	authorizations	高级特性认证时配置
	hidden	配置为true 将在文档中隐藏

@ApiOperation		用于方法上，说明方法的作用，每一个url资源的定义
	value	url的路径
	tags	如果设置这个值，value的值会被覆盖
	notes	对Api资源的描述
	position	设置多个Api显示的顺序位置
	produces	For example, “application/json, application/xml”
	consumes	For example, “application/json, application/xml”
	protocols	Possible values: http, https, ws, wss.
	authorizations	高级特性认证时配置
	hidden	配置为true 将在文档中隐藏
	response	返回的对象
	responseContainer	包含的这些对象是有效的 “List”，“Set”，“Map”，其他无效
	httpMethod	get,head,post,put,delete,options,patch
	code	http的状态码，默认200
	extensions	扩展属性

@ApiParam		用于方法、参数、字段上，表示请求属性
	name	属性名称
	value	属性值
	defaultValue	默认属性值
	allowableValues	可以不用配置
	required	该属性是否必填
	access
	allowMultiple	默认为false
	hidden	是否隐藏该属性
	example	示例

@ApiResponse		用于方法上，响应配置
	code	Http状态码
	message	描述
	response	默认响应类Void
	reference
	responseHeaders	参考下方ResponseHeader的配置
	responseContainer	包含的这些对象是有效的 “List”，“Set”，“Map”，其他无效

@ApiResponses		用于方法上，响应集配置
	value	多个ApiResponse配置

@ResponseHeader		用于方法上，响应头设置
	name	响应头名称
	description	头部描述
	response	默认响应类Void
	responseContainer	参考ApiOperation中配置

@ApiImplicitParams		用于方法上，包含一组参数说明

@ApiImplicitParam		用于方法上，用在@ApiImplicitParams 注解中，指定一个请求参数的各个方面
	paramType	参数放在哪个地方。 · header 参数在request headers 里边提交（@RequestHeader）； · query 直接跟参数完成自动映射赋值（@RequestParam）； · path 用于restful接口，以地址的形式提交数据（@PathVariable）； · body 以流的形式提交仅支持POST（@RequestBody）； · form 以form表单的形式提交仅支持POST
	name	参数名
	value	参数的汉字说明，解释
	dataType	参数类型，默认String，其他值dataType=“Integer”，无用
	required	是否必填
	defaultValue	参数的默认值

@ApiModel		用于类上，描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty		用于方法、字段上，描述一个model的属性

@Apilgnore		用于类、属性、方法上，忽略某项api，使用@ApiIgnore

swagger配置及使用

swagger2注解说明文档相关推荐

swagger2 注解说明文档
注解属性备注 @Api 用于类上,说明该类的作用.可以标记一个Controller类做为swagger 文档资源示例: @Api(value = "xxx", descrip ...
函数的基本知识，定义，调用，参数，返回值，说明文档，函数的嵌套及应用
函数一.函数的使用 1.定义函数参数可有可无 def 函数名(参数):代码1代码2... 2.调用函数函数名(参数) 函数必须先定义在使用 3.例子复现取款机功能 #先定义函数 def fun ...
【java】将自己写的类生成说明文档的方法
使用工具: jdk中的javadoc 实现步骤: 1.将java文件放到一个目录之下 2.进入doc(win+R,输入cmd) 3.通过cd指令进入存放java文件的文件夹 4.编译java文件代码 ...
一键生成表结构说明文档的参考，数据字典生成方式参考
我们经常需要出系统的表结构说明文档,需要拿给客户看,需要给同事看,需要拿给将来做系统维护的人看,编写招标文件等时还需要把一些表结果说明等,都写入到招标文件里去,虽然这些东西,我们手工都可以做,但是工作 ...
Atomikos 中文说明文档【转】
Atomikos 翻译文档(英文文档来源:下载安装包中START_HERE.html) ----译者:周枫请尊重劳动成果,转载请标明 ...
分享个人预算系统源码（含说明文档）
一. 描述本文档用于简单描述预算系统使用操作过程. 预算系统可用于账户金额的管理,包括账户管理,支出记录,收入记录,支出分类,收入分类,转账,封帐,支出配置,存储计划,计划管理. 源代码和文档为个人 ...
Apache安装及jboss部署说明文档
Apache安装及jboss部署说明文档本文为转载 http://oss.org.cn/man/newsoft/jboss.htm#_Toc124845774, 文章内容的准确性有待进一步实验 1 ...
我的产品需求说明文档模板（PRD）
我的产品需求说明文档模板(PRD) 修订记录: 产品简介: 一句话介绍产品产品目标: 介绍产品愿景,描绘产品蓝图项目背景: 在什么背景下做这款产品?为什么要做这款产品?(马云爸爸说过"哪 ...
vnpy官网说明文档网址
接触VNPY一年多,一直对作者设计原理和思想有所困惑.发一篇vnpy官网的说明文档,便于以后理解项目代码. http://www.vnpy.org/archives.html 转载于:https:// ...

swagger2注解说明文档

swagger2注解说明文档相关推荐

最新文章

热门文章