Building Smithy Models

These guides describe how build artifacts are generated from Smithy models, including JARs, OpenAPI specifications, generated code, etc.

Build system overview

Smithy models are built using the Smithy Gradle plugin. The Gradle plugin is a wrapper around a smithy-build and smithy-build.json files, which is where Smithy code generation is configured and most build logic is implemented. This separation allows developers to more easily create build plugins for Smithy without needing deep knowledge of Gradle, and allows build plugins to work with any build tool. For example, Smithy is integrated with Amazon's internal build system using only a lightweight wrapper around smithy-build.

Build system guides

• Smithy Gradle Plugin
  • Installation
  • Smithy model sources
  • Building Smithy models
  • Smithy extension properties
  • Complete Examples
• smithy-build
  • Using smithy-build.json
  • Projections
  • Transforms
  • Environment variables
  • Plugins