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

swagger-to-js-api

v1.3.2

Published

Takes a Swagger JSON API description and creates a Javascript API to call the endpoints. With Flow Types.

Downloads

13

Readme

swagger-to-js-api

Generates a Javascript functional API to consume a Swagger based REST API

Things it does:

  • Provides a nice CLI with docs to consume a swagger JSON file and output to a folder.
  • Creates a JS API that doesn't rely on any library and doesn't assume you use any specific AJAX library. It only assumes that you have a function that accepts objects the same as $http and makes ajax calls for you.
  • It uses Babel core, to create JS code using AST.
  • The original code is generated with inline Flow type definitions based on the Swagger JSON.
  • The original code is given the extension .js.flow while it is compiled to remove Flow types and the compiled files are given the .js extension. This way you get to use compiled standard Javascript code, but the flow types are there if you use them. The flow types give you autocomplete while making API calls and check for mistakes when you pass the wrong types to the functions.
  • The flow types give you errors when you pass in the wrong types of params, and also gives you the type definitions for the response object once you pipeThrough a function.
  • A package.json file is generated and points to the one main file that requires all the functions. This makes the output folder compatible with NPM.
  • Browserify is used to make a standalone file that is written to the dist folder within the output folder. This file is usable with CommonJS, RequireJS or just a browser Global.
  • A bower.json file is generated which points to this standalone build for use in codebases that don't use commonJS (usually with NPM)

TODO

  • Add type for the query param