NSmithy.Client 0.1.0

<p align="center"> <img src="https://raw.githubusercontent.com/thomaslaich/smithy-dotnet/main/website/public/brand/nsmithy_logo_1.png" alt="NSmithy logo" width="320" /> </p>

<p align="center"> <a href="https://github.com/thomaslaich/smithy-dotnet/actions/workflows/ci.yml"> <img src="https://github.com/thomaslaich/smithy-dotnet/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /> </a> <a href="https://thomaslaich.github.io/smithy-dotnet/"> <img src="https://github.com/thomaslaich/smithy-dotnet/actions/workflows/docs.yml/badge.svg?branch=main" alt="Docs" /> </a> <a href="https://www.nuget.org/packages/NSmithy.Client"> <img src="https://img.shields.io/nuget/v/NSmithy.Client" alt="NuGet" /> </a> <a href="https://dotnet.microsoft.com/"> <img src="https://img.shields.io/badge/.NET-net10.0-512BD4" alt=".NET 10" /> </a> <a href="LICENSE"> <img src="https://img.shields.io/github/license/thomaslaich/smithy-dotnet" alt="License" /> </a> <a href="https://github.com/smithy-lang/smithy/releases/tag/1.68.0"> <img src="https://img.shields.io/badge/smithy--cli-1.68.0-orange" alt="Smithy CLI" /> </a> </p>

Preview: NSmithy is in preview — expect some API changes before 1.0. Protocol implementations are not yet on par with the Smithy reference implementations.

NSmithy

Docs · Design Docs · smithy.io

NSmithy is a preview-stage .NET toolkit that turns a Smithy model into idiomatic C# at build time. From a single contract you get typed clients, server scaffolding, and shared model types — fully integrated into your MSBuild workflow.

Features

• Contract-first, protocol-agnostic: Define your service once in Smithy — operations, shapes, and errors — independent of any wire protocol. The same model can target a different protocol without rewriting your contract.
• MSBuild integration: Generate C# models, typed clients, and ASP.NET Core minimal API server stubs from a Smithy IDL as part of dotnet build — no separate codegen step, no Java or JRE installation required.
• Protocol support: REST JSON, REST XML, RPC v2 CBOR, and gRPC.
• Conformance-tested: Validated against official Smithy, AWS, and alloy conformance suites.

Development

The recommended way to work on this repo is with Nix and devenv.

1. Install Nix (recommended: Determinate Nix) and devenv.

2. Optionally install direnv to activate the dev environment automatically when entering the directory (direnv allow). Without it, run devenv shell manually.

3. Use the just recipes to build, test, and package:

   just          # list all available recipes
   just build    # build the codegen JAR and .NET solution
   just test     # run the test suite
   just fmt      # format all code
   just docs     # start the documentation dev server
   just ci       # run the full CI pipeline locally
   

Related Projects

• Smithy — the IDL and protocol framework NSmithy is built on.
• smithy4s — the main inspiration for NSmithy; generates Scala code from Smithy models with similar goals, though with a more sophisticated typeclass-based codec architecture that cleanly separates schema interpretation from serialization.
• alloy — Smithy extensions used by NSmithy for simpleRestJson and gRPC protocols.
• smithy-go / smithy-typescript — official Smithy codegen plugins for Go and TypeScript, which NSmithy draws inspiration from.
• TypeSpec — Microsoft's alternative API description language with similar goals. Compiles to OpenAPI, JSON Schema, Protobuf, and more; has first-party .NET emitters.