Create an example

[steamstreetjon]

Smithy in general is hard to set up. There is almost no information on how to set up a basic project to generate code. Having a few examples would greatly improve the ability for developers to get up and running.

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue, please leave a comment

Describe the Feature

Create some examples of projects with Kotlin codegen enabled.

Is your Feature Request related to a problem?

Figuring out how to set up Kotlin Codegen (and Smithy in general) is really difficult. The concepts seems to be well documented, but the specifics about project setups, etc seem to be rarely described.

Proposed Solution

Just an examples folder with a few basic examples

Additional Context

It may not be obvious to those working on it, but Smithy is a mess to set up. The language is fairly well described, but it's really difficult to understand how to configure things like codegen. Some examples would go a LONG way.

• I may be able to implement this feature request

[ianbotsf]

Hi @steamstreetjon, thanks for the feature request. The smithy-kotlin codegen project is currently only supported for generating the AWS SDK for Kotlin. While nothing explicitly prevents its use for other projects, there are several components missing which may make that difficult (such as standalone protocol support).

We fully plan to release it as a standalone code generator which can be used to build other (non-AWS) SDK, at which time we'll definitely have developer documentation and example projects. But in the short-term the project exists to support the AWS SDK for Kotlin and other efforts for standalone generation are not prioritized.

We'll leave this request open as a tracking mechanism.

[github-actions]

This is a very old issue that is probably not getting as much attention as it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to provide a comment or open a new issue.

[RCHowell]

Are there any updates in regards to the statement below?

The smithy-kotlin codegen project is currently only supported for generating the AWS SDK for Kotlin.

Additionally, are there any examples for either Kotlin (or Java) codegen setup?