Package software.amazon.smithy.openapi.fromsmithy

Class CoreExtension

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.CoreExtension

All Implemented Interfaces:

Smithy2OpenApiExtension

public final class CoreExtension
extends Object
implements Smithy2OpenApiExtension

Registers the core Smithy2OpenApi functionality.

Constructor Summary

Constructors

Constructor	Description
CoreExtension()

Method Summary

Modifier and Type	Method	Description
List<JsonSchemaMapper>	getJsonSchemaMappers()	Registers JsonSchema mappers that are used to modify JsonSchema definitions created from a Smithy model.
List<OpenApiMapper>	getOpenApiMappers()	Registers OpenAPI mappers, classes used to modify and extend the process of converting a Smithy model to OpenAPI.
List<OpenApiProtocol<? extends Trait>>	getProtocols()	Registers additional protocols that handle serialization and deserialization.
List<SecuritySchemeConverter<? extends Trait>>	getSecuritySchemeConverters()	Registers additional security scheme converters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CoreExtension

public CoreExtension()

Method Details

getSecuritySchemeConverters

public List<SecuritySchemeConverter<? extends Trait>> getSecuritySchemeConverters()

Description copied from interface: Smithy2OpenApiExtension

Registers additional security scheme converters.

Specified by:

getSecuritySchemeConverters in interface Smithy2OpenApiExtension

Returns:

Returns the converters to register.

getProtocols

public List<OpenApiProtocol<? extends Trait>> getProtocols()

Description copied from interface: Smithy2OpenApiExtension

Registers additional protocols that handle serialization and deserialization.

Specified by:

getProtocols in interface Smithy2OpenApiExtension

Returns:

Returns the protocols to register.

getOpenApiMappers

public List<OpenApiMapper> getOpenApiMappers()

Description copied from interface: Smithy2OpenApiExtension

Registers OpenAPI mappers, classes used to modify and extend the process of converting a Smithy model to OpenAPI.

Specified by:

getOpenApiMappers in interface Smithy2OpenApiExtension

Returns:

Returns the mappers to register.

getJsonSchemaMappers

public List<JsonSchemaMapper> getJsonSchemaMappers()

Description copied from interface: Smithy2OpenApiExtension

Registers JsonSchema mappers that are used to modify JsonSchema definitions created from a Smithy model.

Specified by:

getJsonSchemaMappers in interface Smithy2OpenApiExtension

Returns:

Returns the mappers to register.