dejunyang的博客

使用场景 在 Rest 接口类上边使用。 概述 标记类为 Swagger 资源类，运行时有效。 属性 属性名称 数据类型 默认值 说明 value String “” 隐式设置操作的标记，遗留支持(读取 description) tags String[] “” 对接口进行分组 produces String “” 采用都好分支的 content types,例如:appl...

使用场景 使用外部文档说明的时候使用，参数，方法，属性上可使用 概述 定义外部文档说明 属性 属性名称 数据类型 默认值 说明 value String “” 目标文档的简要描述，GFM语法可用于富文本表示 url String 引用文档的 URL ...

使用场景 定义 metadata level 时使用，在 Rest 接口或类上使用 概述 配置定义 metadata level的注解。仍然缺少 Security Requirements，Parameters，Responses 属性 属性名称 数据类型 默认值 说明 host String “” 要在生成的Swagger定义中指定的主机 basePath String “”...

@Authorization 使用场景 接口授权，不单独使用，作为 @Api 或 @ApiOperation 的属性使用 概述 定义要在资源或操作上使用的授权方案。使用的授权方案需要首先在Swagger各级别声明。此注解不直接使用，Swagger不会解析，应该作为 @Api 或 @ApiOperation 属性使用 属性 属性名称 数据类型 默认值 说明 value String ...

使用场景 在 Rest 接口上使用 概述 描述针对特定路径的操作，通常是 HTTP 方法。具有等效路径的操作被分到单个分组中。HTTP 方法和路径的组合创建了一个独特的操作 属性 属性名称 数据类型 默认值 说明 value String 接口简要说明，120字符或更少 notes String “” 接口详细描述 tags String[] “” tag 列表，可用于按...

使用场景 在 Rest 接口上或 Rest 接口参数前边使用 概述 为 Rest 接口参数添加其它元数据(导入到 yapi 中不会被解析) 属性 属性名称 数据类型 默认值 说明 name String “” 参数名称，参数名称将从 filed/method/parameter 名称中派生，但你可以覆盖它，路径参数必须始终命名为它们所代表的路径部分 value String “...

使用场景 作为 @ApiResponse 的属性，作为返回数据的一部分，指定返回 header 信息 概述 作为返回数据的一部分提供返回数据的 header 信息 属性 属性名称 数据类型 默认值 说明 name String “” Header’s name. description String “” response header 详细描述 response Clas...

@ApiResponses 使用场景 在 Rest 接口上使用，用作返回值的描述 概述 一个包装器，允许列出多个 ApiResponse，若果你需要描述单个 ApiResponse，你仍然必须使用此注解并将@ApiResponse 包装在一个数组中 属性 属性名称 数据类型 默认值 说明 value ApiResponse[] ApiResponse 列表 @ApiRespo...

@ApiModel 使用场景 在实体类上边使用，标记类时swagger的解析类 概述 提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省 属性 属性名称 数据类型 默认值 说明 value String 类名 为模型提供备用名称 description String “” 提供详细的类描述 parent Class<?> parent Void...

@ApiImplicitParams 使用场景 在 Rest 接口方法上使用来指定请求参数 概述 在 Rest 接口方法上使用来指定请求参数 属性 属性名称 数据类型 默认值 说明 value ApiImplicitParam[] API 可用的参数列表 @ApiImplicitParam 使用场景 场景一：在 Rest 接口上单独使用 @ApiImplicitParam 在...

Swagger注解-@Api Swagger注解-@ApiOperation Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam Swagger注解-@ApiModel 和 @ApiModelProperty Swagger注解-@ApiResponses 和 @ApiResponse Swagger注解-@ResponseHeader Swagger...