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-openapi-repo

v1.0.1

Published

Yeoman generator for OpenAPI(fka Swagger) repo to help you share spec for your API

Downloads

19

Readme

generator-openapi-repo NPM version Dependency Status

Yeoman generator for OpenAPI(fka Swagger) repo to help you share spec for your API

logo

Why?

There are a few advantages in hosting your API specification + docs on GitHub:

  • Community engagement (PR's and issues)
  • Hosting on GitHub pages (perfect uptime, CDN, Jekyll, custom domains with CNAME)
  • Advertisment in the GitHub community
  • Revision history, branching, CI
  • Fast on-boarding time (everyone knows how to use GitHub :smile:)

Features

This generator helps to create a GitHub repo with the following features:

  • Possibility to split a big Swagger spec into smaller files and bundle it for deployment
  • Continuous integration/deployment on Travis
  • Code samples as separate files
  • Swagger spec is validated after each commit
  • Swagger spec + ReDoc deployed to Github Pages (you can use a custom domain)
  • Live editing in your editor or swagger-editor :heart_eyes: live editing

Examples of generated repositories

  • https://github.com/Rebilly/RebillyAPI
  • https://github.com/thingful/openapi-spec
  • https://github.com/TwineHealth/TwineDeveloperDocs

How to generate your repository

We assume you already have node.js installed.

  • First, install Yeoman and generator-openapi-repo:
npm install -g yo
npm install -g generator-openapi-repo
yo openapi-repo
  • Commit and push your changes to the GitHub and follow instruction from README.md of your newly created repo. Note: don't forget to commit the .yo-rc.json file, it contains all answers gave to yeoman, and they are reused during the update procedure.

Updating an existing project

  • First make sure you have committed everything or have a backup
  • Run yo openapi-repo over the project again
  • yo will ask you for each file if you want to overwrite
  • For those files you haven't edited, just say yes
  • For the other ones, type d for diff and see what's changed