Package software.amazon.smithy.openapi.fromsmithy

Interface Smithy2OpenApiExtension

All Known Implementing Classes:
CoreExtension
public interface Smithy2OpenApiExtension
An extension mechanism used to influence how Smithy models are converted to OpenAPI models.

Implementations of this interface are discovered through Java SPI.

  • Method Summary

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

  • Method Details

    • getSecuritySchemeConverters

      default List<SecuritySchemeConverter<? extends software.amazon.smithy.model.traits.Trait>> getSecuritySchemeConverters()
      Registers additional security scheme converters.
      Returns:
      Returns the converters to register.

    • getProtocols

      default List<OpenApiProtocol<? extends software.amazon.smithy.model.traits.Trait>> getProtocols()
      Registers additional protocols that handle serialization and deserialization.
      Returns:
      Returns the protocols to register.

    • getOpenApiMappers

      default List<OpenApiMapper> getOpenApiMappers()
      Registers OpenAPI mappers, classes used to modify and extend the process of converting a Smithy model to OpenAPI.
      Returns:
      Returns the mappers to register.

    • getJsonSchemaMappers

      default List<software.amazon.smithy.jsonschema.JsonSchemaMapper> getJsonSchemaMappers()
      Registers JsonSchema mappers that are used to modify JsonSchema definitions created from a Smithy model.
      Returns:
      Returns the mappers to register.