com.github.xiaoymin.knife4j.annotations

注释类型 ApiOperationSupport

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface ApiOperationSupport

Help Java development engineers build powerful Swagger documents

This annotation belongs to the enhanced annotation of @ApiOperation, which is unique to swagger-bootstrap-ui and provides Swagger's extended attributes.

从以下版本开始:

1.9.4

作者:

xiaoymin@foxmail.com 2019/06/06 19:26

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	author author
String[]	ignoreParameters 请求忽略参数数组
String[]	includeParameters 请求接口包含的参数数组,和ignoreParameters属性对立
int	order Sort Fields
DynamicParameters	params A list of DynamicParameters available to the API operation.
DynamicResponseParameters	responses 动态构建response响应参数说明

元素详细资料

order

public abstract int order

Sort Fields

返回:

排序

默认值:

0

author

public abstract String author

author

返回:

开发者

默认值:

""

params

public abstract DynamicParameters params

A list of DynamicParameters available to the API operation.

返回:

动态类声明

默认值:

@com.github.xiaoymin.knife4j.annotations.DynamicParameters

responses

public abstract DynamicResponseParameters responses

动态构建response响应参数说明

返回:

响应类动态说明

从以下版本开始:

1.9.5

默认值:

@com.github.xiaoymin.knife4j.annotations.DynamicResponseParameters

ignoreParameters

public abstract String[] ignoreParameters

请求忽略参数数组

返回:

过滤参数数组

从以下版本开始:

1.9.5

• 例如新增接口时,某实体类不需要显示Id,即可使用该属性对参数进行忽略.ignoreParameters={"id"}
• 如果存在多个层次的参数过滤,则使用名称.属性的方式,例如 ignoreParameters={"uptModel.id","uptModel.uptPo.id"},其中uptModel是实体对象参数名称,id为其属性,uptPo为实体类,作为uptModel类的属性名称
• 如果参数层级只是一级的情况下,并且参数是实体类的情况下,不需要设置参数名称,直接给定属性值名称即可.

默认值:

{}

includeParameters

public abstract String[] includeParameters

请求接口包含的参数数组,和ignoreParameters属性对立

返回:

包含参数数组

从以下版本开始:

2.0.3

默认值:

{}