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 .NET 4.6+ or .NET Core 1.0.x/1.1.x to be installed on your system!
Install the package globally:
npm install nswag -g
Show available commands:
nswag help
The full .NET Framework is preferred as execution environment. Add the switch --core at the end of the command to execute the .NET Core binaries:
nswag help --core
Install the package for the current project:
npm install nswag --save-dev
Show available commands:
"node_modules/.bin/nswag" help
Run the following command to compile and copy the current NSwag console binaries into the NPM module directory binaries directory:
build/03_Npm_Build.bat
To run the NodeJS binary locally:
cd "src/NSwag.Npm"
node "bin/nswag" help
The JavaScript command line tool can be found here:
src/NSwag.Npm/bin/nswag.json
To publish the package (login required):
build/04_Npm_Publish.bat
FAQs
The Swagger API toolchain for .NET, Web API and TypeScript.
The npm package nswag receives a total of 36,085 weekly downloads. As such, nswag popularity was classified as popular.
We found that nswag demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.