software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApi Maven / Gradle / Ivy
Show all versions of smithy-openapi Show documentation
/*
* Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package software.amazon.smithy.openapi.fromsmithy;
import software.amazon.smithy.build.PluginContext;
import software.amazon.smithy.build.SmithyBuildPlugin;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.openapi.OpenApiConfig;
/**
* 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 {@link OpenApiConfig}.
*/
public final class Smithy2OpenApi implements SmithyBuildPlugin {
@Override
public String getName() {
return "openapi";
}
@Override
public void execute(PluginContext context) {
OpenApiConverter converter = OpenApiConverter.create();
context.getPluginClassLoader().ifPresent(converter::classLoader);
OpenApiConfig config = OpenApiConfig.fromNode(context.getSettings());
ShapeId shapeId = config.getService();
converter.config(config);
ObjectNode openApiNode = converter.convertToNode(context.getModel());
context.getFileManifest().writeJson(shapeId.getName() + ".openapi.json", openApiNode);
}
}