GrailsOpenApiReader (openapi 1.1.0 API)

au.org.ala.plugins.openapi.GrailsOpenApiReader

All Implemented Interfaces and Traits:

io.swagger.v3.oas.integration.api.OpenApiReader
```
@groovy.util.logging.Slf4j
class GrailsOpenApiReader
extends java.lang.Object
```

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_DESCRIPTION`
`static java.lang.String`	`DEFAULT_MEDIA_TYPE_VALUE`
`protected io.swagger.v3.oas.integration.api.OpenAPIConfiguration`	`config`

Properties Summary

Properties
Type	Name and description
`grails.core.GrailsApplication`	`grailsApplication`
`grails.web.mapping.LinkGenerator`	`linkGenerator`

Constructor Summary

Constructors
Constructor and description
`GrailsOpenApiReader ()`
`GrailsOpenApiReader (io.swagger.v3.oas.models.OpenAPI openAPI)`
`GrailsOpenApiReader (io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`io.swagger.v3.oas.models.OpenAPI`	`getOpenAPI()`
	`protected java.lang.String`	`getOperationId(java.lang.String operationId)`
	`protected io.swagger.v3.jaxrs2.ResolvedParameter`	`getParameters(java.lang.reflect.Type type, java.util.List<java.lang.annotation.Annotation> annotations, io.swagger.v3.oas.models.Operation operation, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)`
	`protected java.util.Optional<java.util.List<io.swagger.v3.oas.models.parameters.Parameter>>`	`getParametersListFromAnnotation(io.swagger.v3.oas.annotations.Parameter[] parameters, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, io.swagger.v3.oas.models.Operation operation, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)`
	`protected java.lang.Class<?>`	`getSubResourceWithJaxRsSubresourceLocatorSpecs(java.lang.reflect.Method method)`
	`protected boolean`	`ignoreOperationPath(java.lang.String path, java.lang.String parentPath)`
	`protected boolean`	`ignoreOperationPathStrict(java.lang.String path, java.lang.String parentPath)`
	`protected boolean`	`isMethodOverridden(java.lang.reflect.Method method, java.lang.Class<?> cls)`
	`protected boolean`	`isOperationHidden(java.lang.reflect.Method method)`
	`io.swagger.v3.oas.models.Operation`	`parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)`
	`io.swagger.v3.oas.models.Operation`	parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> classSecurityRequirements, java.util.Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs, java.util.Set<java.lang.String> classTags, java.util.List<io.swagger.v3.oas.models.servers.Server> classServers, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses)
	`io.swagger.v3.oas.models.Operation`	parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> classSecurityRequirements, java.util.Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs, java.util.Set<java.lang.String> classTags, java.util.List<io.swagger.v3.oas.models.servers.Server> classServers, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses, com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)
	`protected io.swagger.v3.oas.models.Operation`	parseMethod(java.lang.Class<?> cls, java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> classSecurityRequirements, java.util.Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs, java.util.Set<java.lang.String> classTags, java.util.List<io.swagger.v3.oas.models.servers.Server> classServers, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses, com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)
	`protected io.swagger.v3.oas.models.media.Content`	`processContent(io.swagger.v3.oas.models.media.Content content, io.swagger.v3.oas.models.media.Schema schema, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes)`
	`protected void`	processRequestBody(io.swagger.v3.oas.models.parameters.Parameter requestBodyParameter, io.swagger.v3.oas.models.Operation operation, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> operationParameters, java.lang.annotation.Annotation[] paramAnnotations, java.lang.reflect.Type type, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, java.util.Map<java.lang.String, io.swagger.v3.oas.models.media.Encoding> encoding)
	`io.swagger.v3.oas.models.OpenAPI`	`read(java.lang.Class<?> cls)` Scans a single class for Swagger annotations - does not invoke ReaderListeners
	`io.swagger.v3.oas.models.OpenAPI`	`read(java.util.Set<java.lang.Class<?>> classes)` Scans a set of classes for both ReaderListeners and OpenAPI annotations.
	`io.swagger.v3.oas.models.OpenAPI`	`read(java.util.Set<java.lang.Class<?>> classes, java.util.Map<java.lang.String, java.lang.Object> resources)`
	`io.swagger.v3.oas.models.OpenAPI`	`read(java.lang.Class<?> cls, java.lang.String parentPath, java.lang.String parentMethod, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, java.util.Set<java.lang.String> parentTags, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> parentParameters, java.util.Set<java.lang.Class<?>> scannedResources)`
	`protected java.lang.String`	`resolveApplicationPath()`
	`void`	`setApplication(Application application)`
	`void`	`setConfiguration(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String DEFAULT_DESCRIPTION
  - public static final java.lang.String DEFAULT_MEDIA_TYPE_VALUE
  - protected io.swagger.v3.oas.integration.api.OpenAPIConfiguration config
- Property Detail
  - grails.core.GrailsApplication grailsApplication
  - grails.web.mapping.LinkGenerator linkGenerator
- Constructor Detail
  - GrailsOpenApiReader()
  - GrailsOpenApiReader(io.swagger.v3.oas.models.OpenAPI openAPI)
  - GrailsOpenApiReader(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)
- Method Detail
  - io.swagger.v3.oas.models.OpenAPI getOpenAPI()
  - protected java.lang.String getOperationId(java.lang.String operationId)
  - protected io.swagger.v3.jaxrs2.ResolvedParameter getParameters(java.lang.reflect.Type type, java.util.List<java.lang.annotation.Annotation> annotations, io.swagger.v3.oas.models.Operation operation, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
  - protected java.util.Optional<java.util.List<io.swagger.v3.oas.models.parameters.Parameter>> getParametersListFromAnnotation(io.swagger.v3.oas.annotations.Parameter[] parameters, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, io.swagger.v3.oas.models.Operation operation, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
  - protected java.lang.Class<?> getSubResourceWithJaxRsSubresourceLocatorSpecs(java.lang.reflect.Method method)
  - protected boolean ignoreOperationPath(java.lang.String path, java.lang.String parentPath)
  - protected boolean ignoreOperationPathStrict(java.lang.String path, java.lang.String parentPath)
  - protected boolean isMethodOverridden(java.lang.reflect.Method method, java.lang.Class<?> cls)
  - protected boolean isOperationHidden(java.lang.reflect.Method method)
  - io.swagger.v3.oas.models.Operation parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
  - io.swagger.v3.oas.models.Operation parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> classSecurityRequirements, java.util.Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs, java.util.Set<java.lang.String> classTags, java.util.List<io.swagger.v3.oas.models.servers.Server> classServers, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses)
  - io.swagger.v3.oas.models.Operation parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> classSecurityRequirements, java.util.Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs, java.util.Set<java.lang.String> classTags, java.util.List<io.swagger.v3.oas.models.servers.Server> classServers, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses, com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)
  - protected io.swagger.v3.oas.models.Operation parseMethod(java.lang.Class<?> cls, java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> classSecurityRequirements, java.util.Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs, java.util.Set<java.lang.String> classTags, java.util.List<io.swagger.v3.oas.models.servers.Server> classServers, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses, com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)
  - protected io.swagger.v3.oas.models.media.Content processContent(io.swagger.v3.oas.models.media.Content content, io.swagger.v3.oas.models.media.Schema schema, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes)
  - protected void processRequestBody(io.swagger.v3.oas.models.parameters.Parameter requestBodyParameter, io.swagger.v3.oas.models.Operation operation, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> operationParameters, java.lang.annotation.Annotation[] paramAnnotations, java.lang.reflect.Type type, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, java.util.Map<java.lang.String, io.swagger.v3.oas.models.media.Encoding> encoding)
  - io.swagger.v3.oas.models.OpenAPI read(java.lang.Class<?> cls)
    
    Scans a single class for Swagger annotations - does not invoke ReaderListeners
  - io.swagger.v3.oas.models.OpenAPI read(java.util.Set<java.lang.Class<?>> classes)
    
    Scans a set of classes for both ReaderListeners and OpenAPI annotations. All found listeners will be instantiated before any of the classes are scanned for OpenAPI annotations - so they can be invoked accordingly.
    Parameters:
    classes - a set of classes to scan
    Returns:
    the generated OpenAPI definition
  - @java.lang.Override io.swagger.v3.oas.models.OpenAPI read(java.util.Set<java.lang.Class<?>> classes, java.util.Map<java.lang.String, java.lang.Object> resources)
  - io.swagger.v3.oas.models.OpenAPI read(java.lang.Class<?> cls, java.lang.String parentPath, java.lang.String parentMethod, boolean isSubresource, io.swagger.v3.oas.models.parameters.RequestBody parentRequestBody, io.swagger.v3.oas.models.responses.ApiResponses parentResponses, java.util.Set<java.lang.String> parentTags, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> parentParameters, java.util.Set<java.lang.Class<?>> scannedResources)
  - protected java.lang.String resolveApplicationPath()
  - void setApplication(Application application)
  - @java.lang.Override void setConfiguration(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GrailsOpenApiReader

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DEFAULT_DESCRIPTION

public static final java.lang.String DEFAULT_MEDIA_TYPE_VALUE

protected io.swagger.v3.oas.integration.api.OpenAPIConfiguration config

Property Detail

grails.core.GrailsApplication grailsApplication

grails.web.mapping.LinkGenerator linkGenerator

Constructor Detail

GrailsOpenApiReader()

GrailsOpenApiReader(io.swagger.v3.oas.models.OpenAPI openAPI)

GrailsOpenApiReader(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)

Method Detail

io.swagger.v3.oas.models.OpenAPI getOpenAPI()

protected java.lang.String getOperationId(java.lang.String operationId)

protected java.lang.Class<?> getSubResourceWithJaxRsSubresourceLocatorSpecs(java.lang.reflect.Method method)

protected boolean ignoreOperationPath(java.lang.String path, java.lang.String parentPath)

protected boolean ignoreOperationPathStrict(java.lang.String path, java.lang.String parentPath)

protected boolean isMethodOverridden(java.lang.reflect.Method method, java.lang.Class<?> cls)

protected boolean isOperationHidden(java.lang.reflect.Method method)

io.swagger.v3.oas.models.Operation parseMethod(java.lang.reflect.Method method, java.util.List<io.swagger.v3.oas.models.parameters.Parameter> globalParameters, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

protected io.swagger.v3.oas.models.media.Content processContent(io.swagger.v3.oas.models.media.Content content, io.swagger.v3.oas.models.media.Schema schema, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes)

io.swagger.v3.oas.models.OpenAPI read(java.lang.Class<?> cls)

io.swagger.v3.oas.models.OpenAPI read(java.util.Set<java.lang.Class<?>> classes)

@java.lang.Override io.swagger.v3.oas.models.OpenAPI read(java.util.Set<java.lang.Class<?>> classes, java.util.Map<java.lang.String, java.lang.Object> resources)

protected java.lang.String resolveApplicationPath()

void setApplication(Application application)

@java.lang.Override void setConfiguration(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)