6872dfc63a
Bumps the aws group with 4 updates: [github.com/aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2), [github.com/aws/aws-sdk-go-v2/config](https://github.com/aws/aws-sdk-go-v2), [github.com/aws/aws-sdk-go-v2/service/s3](https://github.com/aws/aws-sdk-go-v2) and [github.com/aws/smithy-go](https://github.com/aws/smithy-go). Updates `github.com/aws/aws-sdk-go-v2` from 1.32.2 to 1.36.4 <details> <summary>Commits</summary> <ul> <li><a href=" |
||
|---|---|---|
| .. | ||
| auth | ||
| container/private/cache | ||
| context | ||
| document | ||
| encoding | ||
| endpoints | ||
| internal/sync/singleflight | ||
| io | ||
| logging | ||
| metrics | ||
| middleware | ||
| private/requestcompression | ||
| ptr | ||
| rand | ||
| sync | ||
| time | ||
| tracing | ||
| transport/http | ||
| waiter | ||
| .gitignore | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| NOTICE | ||
| README.md | ||
| changelog-template.json | ||
| doc.go | ||
| document.go | ||
| errors.go | ||
| go_module_metadata.go | ||
| local-mod-replace.sh | ||
| modman.toml | ||
| properties.go | ||
| validation.go | ||
README.md
Smithy Go
Smithy code generators for Go and the accompanying smithy-go runtime.
The smithy-go runtime requires a minimum version of Go 1.20.
WARNING: All interfaces are subject to change.
Can I use the code generators?
In order to generate a usable smithy client you must provide a protocol definition, such as AWS restJson1, in order to generate transport mechanisms and serialization/deserialization code ("serde") accordingly.
The code generator does not currently support any protocols out of the box other than the new smithy.protocols#rpcv2Cbor,
therefore the useability of this project on its own is currently limited.
Support for all AWS protocols
exists in aws-sdk-go-v2. We are
tracking the movement of those out of the SDK into smithy-go in
#458, but there's currently no
timeline for doing so.
Plugins
This repository implements the following Smithy build plugins:
| ID | GAV prefix | Description |
|---|---|---|
go-codegen |
software.amazon.smithy.go:smithy-go-codegen |
Implements Go client code generation for Smithy models. |
go-server-codegen |
software.amazon.smithy.go:smithy-go-codegen |
Implements Go server code generation for Smithy models. |
NOTE: Build plugins are not currently published to mavenCentral. You must publish to mavenLocal to make the build plugins visible to the Smithy CLI. The artifact version is currently fixed at 0.1.0.
go-codegen
Configuration
GoSettings
contains all of the settings enabled from smithy-build.json and helper
methods and types. The up-to-date list of top-level properties enabled for
go-client-codegen can be found in GoSettings::from().
| Setting | Type | Required | Description |
|---|---|---|---|
service |
string | yes | The Shape ID of the service for which to generate the client. |
module |
string | yes | Name of the module in generated.json (and go.mod if generateGoMod is enabled) and doc.go. |
generateGoMod |
boolean | Whether to generate a default go.mod file. The default value is false. |
|
goDirective |
string | Go directive of the module. The default value is the minimum supported Go version. |
Supported protocols
| Protocol | Notes |
|---|---|
smithy.protocols#rpcv2Cbor |
Event streaming not yet implemented. |
Example
This example applies the go-codegen build plugin to the Smithy quickstart
example created from smithy init:
{
"version": "1.0",
"sources": [
"models"
],
"maven": {
"dependencies": [
"software.amazon.smithy.go:smithy-go-codegen:0.1.0"
]
},
"plugins": {
"go-codegen": {
"service": "example.weather#Weather",
"module": "github.com/example/weather",
"generateGoMod": true,
"goDirective": "1.20"
}
}
}
go-server-codegen
This plugin is a work-in-progress and is currently undocumented.
License
This project is licensed under the Apache-2.0 License.