Class Smithy2OpenApi

  • All Implemented Interfaces:
    SmithyBuildPlugin

    public final class Smithy2OpenApi
    extends java.lang.Object
    implements SmithyBuildPlugin
    Converts Smithy to an OpenAPI model and saves it as a JSON file.

    This plugin requires a setting named "service" that is the Shape ID of the Smithy service shape to convert to OpenAPI.

    This plugin is configured using OpenApiConfig.

    • Constructor Summary

      Constructors 
      Constructor Description
      Smithy2OpenApi()  
    • Method Summary

      Modifier and Type Method Description
      void execute​(PluginContext context)
      Executes the plugin, creating any number of artifacts.
      java.lang.String getName()
      Gets the name of the plugin.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Smithy2OpenApi

        public Smithy2OpenApi()
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: SmithyBuildPlugin
        Gets the name of the plugin.
        Specified by:
        getName in interface SmithyBuildPlugin
        Returns:
        Returns the name (e.g., "MyPlugin").
      • execute

        public void execute​(PluginContext context)
        Description copied from interface: SmithyBuildPlugin
        Executes the plugin, creating any number of artifacts.
        Specified by:
        execute in interface SmithyBuildPlugin
        Parameters:
        context - Plugin context for build execution.