-
@Target(allowedTargets = {AnnotationTarget.FUNCTION, AnnotationTarget.FIELD}) public @interface OpenApi
Provide metadata for the generation of the open api documentation to the annotated Handler.
-
-
Field Summary
Fields Modifier and Type Field Description private final Boolean
ignore
private final String
summary
private final String
description
private final String
operationId
private final Boolean
deprecated
private final Array<String>
tags
private final Array<OpenApiParam>
cookies
private final Array<OpenApiParam>
headers
private final Array<OpenApiParam>
pathParams
private final Array<OpenApiParam>
queryParams
private final Array<OpenApiFormParam>
formParams
private final OpenApiRequestBody
requestBody
private final OpenApiComposedRequestBody
composedRequestBody
private final Array<OpenApiFileUpload>
fileUploads
private final Array<OpenApiResponse>
responses
private final Array<OpenApiSecurity>
security
private final String
path
private final HttpMethod
method
-