Smithy Examples

This repository contains a range of examples to help you get up and running with Smithy.

Note: You will need the Smithy CLI installed to use the examples in this repository as templates. If you do not have the CLI installed, follow this guide to install it now.

What is Smithy

Smithy is an interface definition language and set of tools that allows developers to build clients and servers in multiple languages. A Smithy model enables API providers to generate clients and servers in various programming languages, API documentation, test automation, and example code.

Examples

• Quick Start - Build the Smithy quick start example.
• Conversion - Convert Smithy models to other formats (such as OpenAPI) and vice versa
• Custom Traits - Create custom Smithy traits to use for defining custom model metadata.
• Projections - Using Smithy projections to create different views of your model for specific consumers.
• Shared Models - Create a package of common Smithy shapes that can be shared between Smithy models.
• Linting and Validation - Use linters and validators to ensure APIs adhere to best practices and standards.

Contributing

Contributions are welcome. Please read the contribution guidelines first.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the MIT-0 License.