Cake NSwag Addin

Cake Addin for code generation from OpenAPI specifications via NSwag

Motivation

NSwag provides a set of powerful code generators for both C# and TypeScript. Because code generation is task that can easily be automated, being able to run it directly from a build tool like Cake can help to save a lot of time and effort.

A Cake Addin for NSwag does already exist (see Cake.NSwag), but sadly, it is outdated and unmaintained. For this addin, I'll do my best to keep it up-to-date both regarding Cake best practices and NSwag code generation features.

Installation

The addin is available on NuGet, so it can simply be registered in your build.cake file via the #addin preprocessor directive:

#addin nuget:?package=Cake.CodeGen.NSwag&version=1.2.0&loaddependencies=true

There is no need to install any additional tools or dependencies.

Usage

When the addin is registered, it adds an extension property called NSwag to the context of the build.cake script. This property provides various methods to define an OpenAPI specification source. Using the returned object, clients for C# and TypeScript can be generated as well as ASP.NET controller templates:

NSwag.FromYamlSpecification("swagger.yaml")                    // or FromJsonSpecification("swagger.json")
    .GenerateCSharpClient("Client.Generated.cs")
    .GenerateTypeScriptClient("client-generated.ts", new TypeScriptClientGeneratorSettings() {
        ClassName = "MyGeneratedClient"
    })
    .GenerateCSharpController("Controller.Generated.cs");

For details on the optional generator settings check out the NSwag documentation. Multiple invocations of the same code generator (e.g. GenerateCSharpClient) with different settings and different output files are possible.

Beside using a local file with an OpenAPI specification, a remote URL can be accessed by passing an URI to the source methods FromYamlSpecification and FromJsonSpecification. Please note, that file URIs cannot be passed via those methods, only http(s) URLs are allowed.

License

The software is licensed under the MIT license.