Package software.amazon.smithy.openapi.fromsmithy

Class Smithy2OpenApi

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApi

All Implemented Interfaces:

software.amazon.smithy.build.SmithyBuildPlugin

public final class Smithy2OpenApi
extends Object
implements software.amazon.smithy.build.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(software.amazon.smithy.build.PluginContext context)
String	getName()

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.build.SmithyBuildPlugin

isSerial, requiresValidModel

Constructor Details

Smithy2OpenApi

public Smithy2OpenApi()

Method Details

getName

public String getName()

Specified by:

getName in interface software.amazon.smithy.build.SmithyBuildPlugin

execute

public void execute(software.amazon.smithy.build.PluginContext context)

Specified by:

execute in interface software.amazon.smithy.build.SmithyBuildPlugin