Contents Menu Expand Light mode Dark mode Auto light/dark mode
⚠️ You are viewing version 1.0.
Version 2.0 is available at https://smithy.io/2.0/.
Smithy 1.0
Logo

Documentation

  • Quick start
  • Specifications
    • Smithy specification
      • 1. The Smithy model
      • 2. Prelude model
      • 3. Constraint traits
      • 4. Documentation traits
      • 5. Type refinement traits
      • 6. Protocol traits
      • 7. Authentication traits
      • 8. Behavior traits
      • 9. Resource traits
      • 10. Streaming Traits
      • 11. HTTP binding traits
      • 12. XML binding traits
      • 13. Endpoint Traits
      • 14. Selectors
      • 15. Model validation
      • 16. Smithy IDL
      • 17. JSON AST
    • HTTP Protocol Compliance Tests
    • Waiters
    • MQTT Protocol Bindings
    • AWS specifications
      • AWS Core Specification
      • AWS Authentication Traits
      • AWS IAM traits
      • Amazon API Gateway traits
      • AWS CloudFormation traits
      • 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
  • Smithy Guides
    • Building Smithy Models
      • Smithy Gradle Plugin
      • smithy-build
    • Model linters
    • Evolving Models
    • Style Guide
    • Converting Smithy to OpenAPI
    • Generating CloudFormation Resource Schemas from Smithy

Implementations

  • Implementations
  • Smithy 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

Project links

  • Source code
  • 2.0 Documentation
Back to top
Edit this page

Smithy Guides#

  • Building Smithy Models
    • Build system overview
    • Build system guides
  • Model linters
    • Linting overview
    • Linters in smithy-linters
    • Writing custom validators
    • Writing custom Linters
  • Evolving Models
    • Updating services
    • Updating operations
    • Updating structures
    • Booleans and API evolution
    • Updating unions
    • Boxed shapes
    • Sparse lists and maps
    • Updating traits
    • Using Smithy Diff
  • Style Guide
    • Model files
    • Model file structure
    • Formatting
    • Naming
  • Converting Smithy to OpenAPI
    • Introduction
    • Differences between Smithy and OpenAPI
    • Converting to OpenAPI with smithy-build
    • OpenAPI configuration settings
    • JSON schema configuration settings
    • Security schemes
    • @examples trait conversion
    • Amazon API Gateway extensions
    • Converting to OpenAPI with code
  • Generating CloudFormation Resource Schemas from Smithy
    • Introduction
    • Generating Schemas with smithy-build
    • CloudFormation configuration settings
    • JSON schema configuration settings
    • Other traits that influence generation
    • Generating Schemas with code
Next
Building Smithy Models
Previous
Amazon S3 Customizations
Copyright © 2022, Amazon Web Services
Made with Sphinx and @pradyunsg's Furo