Skip to main content
Back to top
Ctrl
+
K
Documentation
Examples
Awesome Smithy
Search
Ctrl
+
K
GitHub
Documentation
Examples
Awesome Smithy
Search
Ctrl
+
K
GitHub
Quick start
Smithy specification
The Smithy model
Simple types
Aggregate types
Service types
Mixins
Constraint traits
Type refinement traits
Documentation traits
Behavior traits
Resource traits
Authentication traits
Serialization and Protocol traits
Streaming
HTTP bindings
Endpoint traits
Selectors
Model validation
Shape closures
Smithy IDL
JSON AST
Trait index
Guides
The Smithy CLI
Installation
smithy-build.json
Smithy Gradle Plugins
Migrating to Gradle plugin version 0.10.0+
Code Generation
Updating the Smithy Model
Generating a client
Linting Models
Model Validation Examples
Evolving Models
Wire protocol selection
Style Guide
Model Translations
Converting Smithy to OpenAPI
Smithy IDL 1.0 to 2.0 Migration Guide
Generating CloudFormation Resource Schemas from Smithy
Creating a Code Generator
Overview and Concepts
Mapping Smithy Shapes to Your Language
Creating a Codegen Repo
Configuring the Generator
Implementing the Generator
Making Codegen Pluggable
Generating Code
Decoupling Codegen with Symbols
Using the Semantic Model
Smithy Client Guidance
Application Protocols
HTTP
Context
Retrying Requests
Endpoint Resolution
Glossary
Tutorials
Full Stack Application
Additional specs
Smithy AI Traits
Contract traits
HTTP Protocol Compliance Tests
Event Stream Protocol Compliance Tests
Smoke Tests
Waiters
MQTT Protocol Bindings
Rules engine
Rules engine specification
Rules engine parameters
Rules engine standard library
Protocols
Smithy RPC v2 CBOR protocol
Smithy RPC v2 JSON protocol
AWS integrations
AWS Core Specification
AWS Authentication Traits
AWS Declarative Endpoint Traits
AWS IAM traits
Amazon API Gateway traits
AWS CloudFormation Traits
Amazon Event Stream Specification
AWS Protocols
AWS restJson1 protocol
AWS JSON 1.0 protocol
AWS JSON 1.1 protocol
AWS restXml protocol
AWS query protocol
AWS EC2 query protocol
AWS Service Customizations
Amazon API Gateway Customizations
Amazon Glacier Customizations
Amazon Machine Learning Customizations
Amazon S3 Customizations
AWS rules engine extensions
AWS rules engine built-ins
AWS rules engine library functions
AWS rules engine authentication scheme validators
Languages
Java
Java Quickstart
Client User Guide
Generating Clients
Configuring Clients
Customizing Client Behavior
Client Plugins
Dynamic Client
Source code
Smithy Java Examples
TypeScript
TypeScript Quickstart
Server Generator for TypeScript
Introduction to the Smithy Server Generator for TypeScript
Smithy Server Generator for TypeScript handlers
Smithy Server Generator for TypeScript validation
Smithy Server Generator for TypeScript error handling
Smithy Server Generator for TypeScript supported endpoints
Source code
Smithy Full Stack Application
Rust
Design Documentation
Source code
Python
Source code
Kotlin
Kotlin Quickstart
Client User Guide
Generating Clients
Source code
Smithy Kotlin Examples
Smithy Kotlin Design Docs
GoLang
Source code
Scala
Documentation
Source code
Project
Source code
Awesome Smithy
Smithy Examples
1.0 Documentation
Repository
Suggest edit
Open issue
Protocols
Protocols
#
Smithy RPC v2 CBOR protocol
Smithy RPC v2 JSON protocol
