QueryNoPagingOperation (hsweb-commons-api 4.0.8 API)

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface QueryNoPagingOperation

可选元素概要

可选元素
限定符和类型	可选元素和说明
`boolean`	`deprecated` Allows an operation to be marked as deprecated.
`String`	`description` A verbose description of the operation.
`io.swagger.v3.oas.annotations.extensions.Extension[]`	`extensions` The list of optional extensions
`io.swagger.v3.oas.annotations.ExternalDocumentation`	`externalDocs` Additional external documentation for this operation.
`boolean`	`hidden` Allows this operation to be marked as hidden
`boolean`	`ignoreJsonView` Ignores JsonView annotations while resolving operations and types.
`String`	`method` The HTTP method for this operation.
`String`	`operationId` The operationId is used by third-party tools to uniquely identify this operation.
`io.swagger.v3.oas.annotations.Parameter[]`	`parameters` An optional array of parameters which will be added to any automatically detected parameters in the method itself.
`io.swagger.v3.oas.annotations.parameters.RequestBody`	`requestBody` Request body associated to the operation.
`io.swagger.v3.oas.annotations.responses.ApiResponse[]`	`responses` The list of possible responses as they are returned from executing this operation.
`io.swagger.v3.oas.annotations.security.SecurityRequirement[]`	`security` A declaration of which security mechanisms can be used for this operation.
`io.swagger.v3.oas.annotations.servers.Server[]`	`servers` An alternative server array to service this operation.
`String`	`summary` Provides a brief description of this operation.
`String[]`	`tags` Tags can be used for logical grouping of operations by resources or any other qualifier.

- 元素详细资料
  - method
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract String method
```
    The HTTP method for this operation.
    
    返回:
    
    the HTTP method of this operation
    
    默认值:
    
    ""
- - tags
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract String[] tags
```
    Tags can be used for logical grouping of operations by resources or any other qualifier.
    
    返回:
    
    the list of tags associated with this operation
    
    默认值:
    
    {}
- - summary
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract String summary
```
    Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.
    
    返回:
    
    a summary of this operation
    
    默认值:
    
    ""
- - description
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract String description
```
    A verbose description of the operation.
    
    返回:
    
    a description of this operation
    
    默认值:
    
    ""
- - requestBody
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.parameters.RequestBody requestBody
```
    Request body associated to the operation.
    
    返回:
    
    a request body.
    
    默认值:
    
    @io.swagger.v3.oas.annotations.parameters.RequestBody
- - externalDocs
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.ExternalDocumentation externalDocs
```
    Additional external documentation for this operation.
    
    返回:
    
    additional documentation about this operation
    
    默认值:
    
    @io.swagger.v3.oas.annotations.ExternalDocumentation
- - operationId
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract String operationId
```
    The operationId is used by third-party tools to uniquely identify this operation.
    
    返回:
    
    the ID of this operation
    
    默认值:
    
    ""
- - parameters
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.Parameter[] parameters
```
    An optional array of parameters which will be added to any automatically detected parameters in the method itself.
    
    返回:
    
    the list of parameters for this operation
    
    默认值:
    
    {@io.swagger.v3.oas.annotations.Parameter(name="where", description="\u6761\u4ef6\u8868\u8fbe\u5f0f,\u548cterms\u53c2\u6570\u51b2\u7a81", example="id = 1", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="orderBy", description="\u6392\u5e8f\u8868\u8fbe\u5f0f,\u548csorts\u53c2\u6570\u51b2\u7a81", example="id desc", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="includes", description="\u6307\u5b9a\u8981\u67e5\u8be2\u7684\u5217,\u591a\u5217\u4f7f\u7528\u9017\u53f7\u5206\u9694", example="id", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="excludes", description="\u6307\u5b9a\u4e0d\u67e5\u8be2\u7684\u5217,\u591a\u5217\u4f7f\u7528\u9017\u53f7\u5206\u9694", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="terms[0].column", description="\u6307\u5b9a\u6761\u4ef6\u5b57\u6bb5", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="terms[0].termType", description="\u6761\u4ef6\u7c7b\u578b", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), example="like", in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="terms[0].type", description="\u591a\u4e2a\u6761\u4ef6\u7ec4\u5408\u65b9\u5f0f", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=org.hswebframework.ezorm.core.param.Term.Type.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="terms[0].value", description="\u6761\u4ef6\u503c", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="sorts[0].name", description="\u6392\u5e8f\u5b57\u6bb5", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY), @io.swagger.v3.oas.annotations.Parameter(name="sorts[0].order", description="\u987a\u5e8f,asc\u6216\u8005desc", schema=@io.swagger.v3.oas.annotations.media.Schema(implementation=java.lang.String.class), in=io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY)}
- - responses
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.responses.ApiResponse[] responses
```
    The list of possible responses as they are returned from executing this operation.
    
    返回:
    
    the list of responses for this operation
    
    默认值:
    
    {}
- - deprecated
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract boolean deprecated
```
    Allows an operation to be marked as deprecated. Alternatively use the @Deprecated annotation
    
    返回:
    
    whether or not this operation is deprecated
    
    默认值:
    
    false
- - security
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.security.SecurityRequirement[] security
```
    A declaration of which security mechanisms can be used for this operation.
    
    返回:
    
    the array of security requirements for this Operation
    
    默认值:
    
    {}
- - servers
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.servers.Server[] servers
```
    An alternative server array to service this operation.
    
    返回:
    
    the list of servers hosting this operation
    
    默认值:
    
    {}
- - extensions
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract io.swagger.v3.oas.annotations.extensions.Extension[] extensions
```
    The list of optional extensions
    
    返回:
    
    an optional array of extensions
    
    默认值:
    
    {}
- - hidden
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract boolean hidden
```
    Allows this operation to be marked as hidden
    
    返回:
    
    whether or not this operation is hidden
    
    默认值:
    
    false
- - ignoreJsonView
```
@AliasFor(annotation=io.swagger.v3.oas.annotations.Operation.class)
public abstract boolean ignoreJsonView
```
    Ignores JsonView annotations while resolving operations and types.
    
    返回:
    
    whether or not to ignore JsonView annotations
    
    默认值:
    
    false

注释类型 QueryNoPagingOperation

可选元素概要

元素详细资料

method

tags

summary

description

requestBody

externalDocs

operationId

parameters

responses

deprecated

security

servers

extensions

hidden

ignoreJsonView