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

swagjs

v1.0.0

Published

Modular Swagger Spec Builder

Downloads

3

Vulnerabilities

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

Links

Git

Maintainers

vitor.salgadovitor.salgado

Keywords

clitoolsswaggerspecsapiapisdocumentation

Readme

SwagJS

Build Status Coverage Status Maintainability

Modular Swagger Spec Builder.

SwagJs enables you to build modular Swagger Documentation.
You can create separate files for paths, models, tags and base configuration.
The example directory contains a sample modularized Swagger Documentation.

Install

npm i swagjs -g

Usage

You can create a Node.js based Swagger Specs Server or generate only a merged spec from your modular documentation.
This library uses files pattern to identify which one is a model definition, a path definition and so on. You can configure the file pattern the way you like in the command line providing the parameters:

--model-pattern
--path-pattern

Below the available command description.

Help

swagjs --help 
swagjs gen --help
swagjs server --help

Merging Modular Spec

# sample
swagjs gen ./specs_root_dir --output=./output_file

Swagger Server With Modular Spec

# sample
server ./specs_root_dir --port=8080

License

This project is available under Apache Public License version 2.0. See LICENSE.