Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

nswag

Package Overview
Dependencies
Maintainers
1
Versions
280
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

nswag

The Swagger API toolchain for .NET, Web API and TypeScript.

  • 11.7.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
42K
decreased by-30.6%
Maintainers
1
Weekly downloads
 
Created
Source

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.1+ or .NET Core 1.0/1.1/2.0 to be installed on your system!

  • More information about NSwag
  • More information about the available commands

Usage

Global installation

Install the package globally:

npm install nswag -g

Show available commands:

nswag help

Project installation

Install the package for the current project:

npm install nswag --save-dev

Show available commands:

"node_modules/.bin/nswag" help

Change 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 run version --x86

Add the switch --core to the command to execute one of the .NET Core binaries (automatically detects whether .NET Core 1.0 or 1.1 is installed):

nswag run version --core

To specify what .NET Core binaries to execute, either use

nswag run version --core 1.0

or

nswag run version --core 1.1

or

nswag run version --core 2.0

Development

Run the following command to compile and copy the current NSwag console binaries into the NPM module directory binaries directory:

build/01_Npm_Build.bat

To run the NodeJS binary locally:

cd "src/NSwag.Npm"
node "bin/nswag" version

The JavaScript command line tool can be found here:

src/NSwag.Npm/bin/nswag.json

To publish the package (login required):

build/02_Npm_Publish.bat

Keywords

FAQs

Package last updated on 11 Sep 2017

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc