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

generator-swagger-docker-api

v1.0.1

Published

Yeoman generator for a starter API

Downloads

77

Readme

generator-swagger-docker-api

Quickly scaffold your new API by using a Yeoman generator!

How to use

Steps:

  1. Install yeoman
    $ npm i -g yo
  2. Install generator-swagger-docker-api
    $ npm i -g generator-swagger-docker-api
  3. Run the generator with your app name & company name
    $ yo swagger-docker-api <<app-name>> <<company-name>>
  4. Profit! Or at least have your API scaffolded out so you can start doing all of the things

The package.json version defaults to 1.0.0, but this can be overridden using:

$ yo swagger-docker-api <<app-name>> <<company-name>> --ver=<<version>>

Note that this project uses Swagger for a spec-first API development workflow! Get to know the Swagger 2.0 specification.

After the spec is authored, use $ npm run spec:build to create a spec.json file. The swagger-tools middleware will automagically handle Express routing based on the spec.json file. Which is pretty cool. In-depth running instructions are provided in the generated README.

Contribute

This is a beginning work-in-progress, so feel free to provide feedback! Clone it, fork it, adapt it, whatever you need. This is intended to be pretty generic for people that want Dockerized and Swaggerized APIs.

Credit

This project was adapted from exp-starter-api by craftninja