The Swagger (Open API) toolchain for .NET, Web API and TypeScript.
C# TypeScript Liquid JavaScript HTML CSS Other
Switch branches/tags
NSwag-Build-956 NSwag-Build-955 NSwag-Build-950 NSwag-Build-947 NSwag-Build-937 NSwag-Build-936 NSwag-Build-932 NSwag-Build-931 NSwag-Build-929 NSwag-Build-927 NSwag-Build-924 NSwag-Build-922 NSwag-Build-920 NSwag-Build-918 NSwag-Build-916 NSwag-Build-911 NSwag-Build-909 NSwag-Build-906 NSwag-Build-904 NSwag-Build-902 NSwag-Build-900 NSwag-Build-899 NSwag-Build-898 NSwag-Build-897 NSwag-Build-895 NSwag-Build-893 NSwag-Build-891 NSwag-Build-889 NSwag-Build-887 NSwag-Build-885 NSwag-Build-881 NSwag-Build-879 NSwag-Build-877 NSwag-Build-875 NSwag-Build-873 NSwag-Build-871 NSwag-Build-869 NSwag-Build-868 NSwag-Build-866 NSwag-Build-863 NSwag-Build-859 NSwag-Build-857 NSwag-Build-855 NSwag-Build-851 NSwag-Build-849 NSwag-Build-847 NSwag-Build-845 NSwag-Build-843 NSwag-Build-841 NSwag-Build-840 NSwag-Build-835 NSwag-Build-833 NSwag-Build-831 NSwag-Build-829 NSwag-Build-827 NSwag-Build-825 NSwag-Build-822 NSwag-Build-820 NSwag-Build-817 NSwag-Build-815 NSwag-Build-813 NSwag-Build-811 NSwag-Build-809 NSwag-Build-807 NSwag-Build-805 NSwag-Build-801 NSwag-Build-799 NSwag-Build-796 NSwag-Build-794 NSwag-Build-793 NSwag-Build-792 NSwag-Build-791 NSwag-Build-789 NSwag-Build-787 NSwag-Build-785 NSwag-Build-783 NSwag-Build-781 NSwag-Build-779 NSwag-Build-777 NSwag-Build-775 NSwag-Build-774 NSwag-Build-771 NSwag-Build-769 NSwag-Build-767 NSwag-Build-765 NSwag-Build-763 NSwag-Build-761 NSwag-Build-754 NSwag-Build-753 NSwag-Build-751 NSwag-Build-749 NSwag-Build-748 NSwag-Build-746 NSwag-Build-744 NSwag-Build-742 NSwag-Build-740 NSwag-Build-738 NSwag-Build-736 NSwag-Build-734 NSwag-Build-731
Nothing to show

NSwag: The Swagger (Open API) toolchain for .NET, Web API and TypeScript

NuGet Version npm Build status Build status MyGet CI Gitter StackOverflow

NSwag is a Swagger 2.0 API (OpenAPI) toolchain for .NET, Web API, ASP.NET Core, TypeScript (jQuery, AngularJS, Angular 2+, Aurelia, KnockoutJS, and more) and other platforms, written in C#. The Swagger specification uses JSON and JSON Schema to describe a RESTful web API. The NSwag project provides tools to generate Swagger specifications from existing ASP.NET Web API controllers and client code from these Swagger specifications.

The project combines the functionality of Swashbuckle (Swagger generation) and AutoRest (client generation) in one toolchain. This way a lot of incompatibilites can be avoided and features which are not well described by the Swagger specification or JSON Schema are better supported (e.g. inheritance, enum and reference handling). The NSwag project heavily uses NJsonSchema for .NET for JSON Schema handling and C#/TypeScript class/interface generation.


The project is developed and maintained by Rico Suter and other contributors.

Ways to use the toolchain:


Swagger Generators:

Code Generators:

  • CSharp Client
    • SwaggerToCSharpClientGenerator
      • Generates C# clients from a Swagger specification
      • Generates POCOs or classes implementing INotifyPropertyChanged supporting DTOs
      • The generated clients can be used with full .NET, .NET Core, Xamarin and .NET Standard 1.4 in general
  • CSharp Controllers (contract first/schema first development)
  • TypeScript Client
    • SwaggerToTypeScriptClientGenerator
      • Generates TypeScript clients from a Swagger specification
      • Available templates/supported libraries:
        • JQuery with Callbacks, JQueryCallbacks
        • JQuery with promises JQueryPromises
        • AngularJS using $http, AngularJS
        • Angular (v2+) using the http service, Angular
        • window.fetch API and ES6 promises, Fetch (use this template in your React/Redux app)
        • Aurelia using the HttpClient from aurelia-fetch-client, Aurelia (based on the Fetch template)


NPM Packages

  • NSwag: Command line tools (.NET and .NET Core) distributed as NPM package

NuGet Packages


  • NSwag.Core (.NET Standard 1.0 and .NET 4.5):
  • NSwag.Core.Yaml (.NET Standard 1.3 and .NET 4.5):
    • Extensions to read and write YAML Swagger specifications
  • NSwag.Annotations (.NET Standard 1.0 and .NET 4.5):
    • Attributes to decorate Web API controllers to control the Swagger generation

Swagger generation:

Code generation:



  • NSwag.AssemblyLoader (.NET Standard 1.6 and .NET 4.5.1):
    • Classes to load assemblies in an isolated AppDomain and generate Swagger specs from Web API controllers
  • NSwag.Commands (.NET Standard 1.6 and .NET 4.5.1+):
    • Commands for the command line tool implementations and UI
  • NSwag.MSBuild (MSBuild .targets):
    • Adds a .targets file to your Visual Studio project, so that you can run the NSwag command line tool in an MSBuild target, see MSBuild
  • NSwag.ConsoleCore (.NET Core 1.0, 1.1 and 2.0):
    • Command line tool for .NET Core (dotnet nswag)
  • NSwagStudio (Chocolatey, Windows):
    • Package to install the NSwagStudio and command line tools via Chocolatey

CI NuGet Feed:

The NuGet packages may require the Microsoft.NETCore.Portable.Compatibility package on .NET Core/UWP targets (if mscorlib is missing).


Usage in C#

The following code shows how to read a Swagger specification and generate C# client classes to call the described web services:

var swaggerSettings = new WebApiToSwaggerGeneratorSettings();
var swaggerGenerator = new WebApiToSwaggerGenerator(swaggerSettings);

var document = await swaggerGenerator.GenerateForControllerAsync<PersonsController>();

var clientSettings = new SwaggerToCSharpClientGeneratorSettings 
    ClassName = "MyClass",
    CSharpGeneratorSettings = 
        Namespace = "MyNamespace"
var clientGenerator = new SwaggerToCSharpClientGenerator(document, clientSettings);

var code = clientGenerator.GenerateFile();

Check out the project Wiki for more information.


The generators can be used in a comfortable and simple Windows GUI called NSwagStudio: