https://github.com/smithy-lang/smithy-examples

A collection of examples to help users get up and running with Smithy
https://github.com/smithy-lang/smithy-examples

api aws build-tool codegen examples smithy smithy-models

Last synced: 25 days ago
JSON representation

A collection of examples to help users get up and running with Smithy

• Host: GitHub
• URL: https://github.com/smithy-lang/smithy-examples
• Owner: smithy-lang
• License: mit-0
• Created: 2023-06-01T19:14:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-29T20:24:40.000Z (3 months ago)
• Last Synced: 2024-08-30T21:41:15.349Z (3 months ago)
• Topics: api, aws, build-tool, codegen, examples, smithy, smithy-models
• Language: Java
• Homepage: https://smithy.io
• Size: 7.73 MB
• Stars: 35
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-smithy - Smithy Examples - anvil.svg" alt="(official)" title="Smithy Official" height="10px"> - A collection of examples to help you get up and running with Smithy. (Learning resources / Server Code Generators)

README

        
# Smithy Examples

[![Build Status](https://github.com/smithy-lang/smithy-examples/workflows/integ/badge.svg)](https://github.com/smithy-lang/smithy-examples/actions/workflows/integ.yml)

This repository contains a range of examples to help you get up and running with [Smithy](https://smithy.io).

*Note*: You will need the [Smithy CLI](https://smithy.io/2.0/guides/smithy-cli/index.html) installed to use the examples in this

repository as templates.

If you do not have the CLI installed, follow [this guide](https://smithy.io/2.0/guides/smithy-cli/index.html) 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](quickstart-examples) - Build the Smithy [quick start example](https://smithy.io/2.0/quickstart.html).

- [Conversion](conversion-examples) - Convert Smithy models to other formats (such as OpenAPI) and vice versa 

- [Custom Traits](custom-trait-examples) - Create custom Smithy [traits](https://smithy.io/2.0/spec/model.html#traits) to use for defining custom model metadata.

- [Projections](projection-examples) - Using Smithy [projections](https://smithy.io/2.0/guides/building-models/build-config.html#projections) to create different views of 

  your model for specific consumers.

- [Shared Models](shared-model-examples) - Create a package of common Smithy shapes that can be shared between Smithy models.

- [Linting and Validation](linting-and-validation-examples) - Use linters and validators to ensure APIs adhere to best practices and standards.

## Contributing

Contributions are welcome. Please read the [contribution guidelines](CONTRIBUTING.md) first.

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This project is licensed under the MIT-0 License.