npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nswag

v14.2.0

Published

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

Downloads

229,226

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

rsuterrsuter

Keywords

nswag

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 -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 version /runtime:WinX86

Add 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:NetCore

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

nswag version /runtime:Net80

or

nswag version /runtime:Net90

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.js

To publish the package (login required):

build/02_Npm_Publish.bat