Package io.swagger.v3.jaxrs2.ext

Interface OpenAPIExtension

All Known Implementing Classes:

AbstractOpenAPIExtension, DefaultParameterExtension

public interface OpenAPIExtension

Method Summary

Modifier and Type	Method	Description
void	decorateOperation(Operation operation, Method method, Iterator<OpenAPIExtension> chain)	Decorates operation with additional vendor based extensions.
String	extractOperationMethod(Method method, Iterator<OpenAPIExtension> chain)
ResolvedParameter	extractParameters(List<Annotation> annotations, Type type, Set<Type> typesToSkip, Components components, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, boolean includeRequestBody, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, Iterator<OpenAPIExtension> chain)
default void	setOpenAPI31(boolean openapi31)
default void	setSchemaResolution(Schema.SchemaResolution schemaResolution)

Method Detail

extractOperationMethod

String extractOperationMethod(Method method,
                              Iterator<OpenAPIExtension> chain)

extractParameters

ResolvedParameter extractParameters(List<Annotation> annotations,
                                    Type type,
                                    Set<Type> typesToSkip,
                                    Components components,
                                    javax.ws.rs.Consumes classConsumes,
                                    javax.ws.rs.Consumes methodConsumes,
                                    boolean includeRequestBody,
                                    com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                    Iterator<OpenAPIExtension> chain)

decorateOperation

void decorateOperation(Operation operation,
                       Method method,
                       Iterator<OpenAPIExtension> chain)

Decorates operation with additional vendor based extensions.

Parameters:

operation - the operation, build from swagger definition

method - the method for additional scan

chain - the chain with swagger extensions to process

setOpenAPI31

default void setOpenAPI31(boolean openapi31)

setSchemaResolution

default void setSchemaResolution(Schema.SchemaResolution schemaResolution)