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" or "Map".,其他无效 | |
httpMethod | "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH" | |
code | http的状态码 默认 200 | |
extensions | 扩展属性 | |
@ApiParam |
用于方法、参数、字段上,请求属性 示例: |
|
name | 属性名称 | |
value | 属性值 | |
defaultValue | 默认属性值 | |
allowableValues | 可以不配置 | |
required | 是否属性必填 | |
access | ||
allowMultiple | 默认为false | |
hidden | 隐藏该属性 | |
example | 示例 | |
@ApiResponse |
用于方法上,响应配置 示例: @ApiResponse(code = 400, message = "Invalid user supplied") |
|
code | http的状态码 | |
message | 描述 | |
response | 默认响应类 Void | |
reference | 参考ApiOperation中配置 | |
responseHeaders | 参考 ResponseHeader 属性配置说明 | |
responseContainer | 参考ApiOperation中配置 | |
@ApiResponses |
用于方法上,响应集配置 示例: @ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") }) |
|
value | 多个ApiResponse配置 | |
@ResponseHeader |
用于方法上,响应头设置 示例: @ResponseHeader(name="head1",description="response head conf") |
|
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的属性 | |
@ApiIgnore | 用于类,属性,方法上,忽略某项api,使用@ApiIgnore | |
swagger2 注解说明文档相关推荐
- swagger2注解说明文档
注解 属性 说明 @Api 用于类上,说明该类的作用.可以标记一个controller类作为swagger的文档资源 value url的路径 tags 如果设置这个值,value的值会被覆盖 des ...
- 函数的基本知识,定义,调用,参数,返回值,说明文档,函数的嵌套及应用
函数 一.函数的使用 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:// ...
最新文章
- 微软、华为海思、高通等 50 家公司源代码被泄露!
- 少儿编程python线上课程-北京Python程序开发课程
- mfc vs2013 项目怎么更改类名_VS2010 更改MFC标题及标题栏图标和exe图标
- RabbitMQ(三):Exchange交换器--fanout
- P4016 负载平衡问题(最小费用最大流)
- 索引-python核心技术-pyhui版
- 数据结构21:递归可视化(谢尔宾斯基三角形)
- 如何获得免费卡巴斯基激活码?
- html设置div大小位置不变,div大小 div固定大小设置
- 强化学习——策略学习
- 厨神之路一--群英荟萃1
- google s2 java开发文档
- Python 数据分析学什么
- 04 MapReduce
- 两个数组合并成一个数组
- pytest框架之mark标记功能详细介绍
- laravel银联支付
- 3d打印出现孔洞和裂缝问题
- 推荐几个 Windows 小工具
- 小米电视2 android版本,小米电视2的配置参数是什么?小米电视2标配有什么?