nswag
v14.6.3
Published
The Swagger API toolchain for .NET, Web API and TypeScript.
Readme
NSwag is a Swagger 2.0 API (OpenAPI) toolchain for .NET, Web API, 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.
This NPM module requires Full .NET Framework 4.6.2+ or .NET 6.0+ to be installed on your system!
Usage
Global installation
Install the package globally:
npm install nswag -gShow available commands:
nswag helpProject installation
Install the package for the current project:
npm install nswag --save-devShow available commands:
"node_modules/.bin/nswag" helpChange runtime
The full .NET Framework in x64 mode is preferred as execution environment. If you need to run the command line tool in x86 mode use
nswag version /runtime:WinX86Add the switch /runtime:NetCore* to the command to execute one of the .NET Core binaries (automatically detects whether .NET Core 1.0 or 1.1 is installed):
nswag version /runtime:NetCoreTo specify what .NET Core binaries to execute, either use (default, .NET 8.0)
nswag version /runtime:Net80or for .NET 9.0:
nswag version /runtime:Net90or for .NET 10.0:
nswag version /runtime:Net100Development
Run the following command to compile and copy the current NSwag console binaries into the NPM module directory binaries directory:
build/01_Npm_Build.batTo run the NodeJS binary locally:
cd "src/NSwag.Npm"
node "bin/nswag" versionThe JavaScript command line tool can be found here:
src/NSwag.Npm/bin/nswag.jsTo publish the package (login required):
build/02_Npm_Publish.bat