VictoriaMetrics/vendor/github.com/aws/smithy-go
2024-11-29 13:48:50 +01:00
..
auth vendor: run make vendor-update 2023-11-16 20:20:27 +01:00
container/private/cache vendor: run make vendor-update 2023-12-11 10:48:36 +02:00
context vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
document vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
encoding vendor: run make vendor-update 2024-11-29 13:48:50 +01:00
endpoints vendor: run make vendor-update 2023-12-11 10:48:36 +02:00
internal/sync/singleflight vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
io vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
logging vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
metrics vendor: run make vendor-update 2024-09-26 22:33:05 +02:00
middleware vendor: run make vendor-update 2024-09-26 22:33:05 +02:00
private/requestcompression vendor: run make vendor-update 2023-12-11 10:48:36 +02:00
ptr vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
rand vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
sync vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
time vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
tracing vendor: run make vendor-update 2024-09-26 22:33:05 +02:00
transport/http vendor: run make vendor-update 2024-11-29 13:48:50 +01:00
waiter vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
.gitignore vendor: run make vendor-update 2024-02-14 15:44:03 +02:00
.travis.yml vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
CHANGELOG.md vendor: run make vendor-update 2024-11-29 13:48:50 +01:00
CODE_OF_CONDUCT.md vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
CONTRIBUTING.md vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
doc.go vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
document.go vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
errors.go vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
go_module_metadata.go vendor: run make vendor-update 2024-11-29 13:48:50 +01:00
LICENSE vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
local-mod-replace.sh vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
Makefile vendor: run make vendor-update 2024-02-14 15:44:03 +02:00
modman.toml vendor: run make vendor-update 2024-02-24 03:22:39 +02:00
NOTICE vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00
properties.go vendor: run make vendor-update 2024-09-26 22:33:05 +02:00
README.md vendor: run make vendor-update 2024-09-08 21:05:06 +02:00
validation.go vmbackup: update AWS SDK to v2 (#3174) 2022-10-01 17:12:07 +03:00

Smithy Go

Go Build StatusCodegen Build Status

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.