TypedRest Code Generation

This website documents the API of the TypedRest Code Generation libraries. Use them to build your own tools that infer TypedRest Endpoints from patterns in OpenAPI/Swagger documents and generate client source code.

If you just want to generate a client for your API, use the source generator or the command-line tool instead. Both are built on these libraries.

var reader = new OpenApiStreamReader(new OpenApiReaderSettings().AddTypedRest());
var doc = reader.Read(File.OpenRead("myapi.yml"), out _);

foreach (var type in doc.GenerateTypedRest(new GenerationOptions("MyService")
{
    Namespace = "MyCompany.MyService",
    GenerateInterfaces = true,
    GenerateDtos = true
}))
    type.WriteToDirectory("myclient/");

NuGet packages

Package	Namespace	Description
TypedRest.CodeGeneration	TypedRest.CodeGeneration	Parses OpenAPI/Swagger documents and infers TypedRest Endpoints from patterns.
TypedRest.CodeGeneration.CSharp	TypedRest.CodeGeneration.CSharp	Generates C# source code for TypedRest .NET clients from OpenAPI/Swagger documents.
TypedRest.CodeGeneration.CSharp.SourceGenerator		Roslyn source generator that builds clients during compilation.
typedrest-codegen		Command-line tool that writes the generated code to disk.

Dependencies

flowchart TD
    cli["typedrest-codegen"] --> csharp
    sourcegen["TypedRest.CodeGeneration.CSharp.<br>SourceGenerator"] --> csharp
    csharp["TypedRest.CodeGeneration.<br>CSharp"] --> core
    core["TypedRest.CodeGeneration"]