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

swaggy-c

v0.1.0

Published

Builder for Swagger CodeGen-generated API clients in multiple languages

Downloads

5

Vulnerabilities

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

Links

Git

Maintainers

cliffanocliffano

Keywords

code generatorswaggerapiopenapi

Readme

Build Status Dependencies Status Coverage Status Published Version npm Badge

Swaggy C

Swaggy C is a builder for Swagger CodeGen-generated API clients in multiple languages.

It's handy for generating multiple API clients, along with documentations and package artifacts, from an OpenAPI spec in one go.

(WIP) This builder provides convenient commands for executing the following actions:

  • -gen: generating API client using Swagger CodeGen
  • -deps: resolving dependencies
  • -test: running generated unit tests
  • -package: building package artifact
  • -install: installing package locally
  • -doc: generating documentation
  • -publish: publishing package to public repository

Have a look at Swaggy Jenkins as an example project that was built using Swaggy C.

Installation

npm install -g swaggy-c

Usage

Build a JavaScript API client with a given spec:

swaggy-c --api-spec /path/to/spec.yaml javascript

The generated JavaScript client will then be written to output directory specified in --out-dir flag.

Build the client using Swagger CodeGen CLI jar, handy for using custom built jar (e.g. from master branch):

swaggy-c --jar /path/to/swagger-codegen-cli.jar --api-spec /path/to/spec.yaml javascript

Build the client using specific configuration, output, and log directories:

swaggy-c --conf-file /path/to/conf.json --out-dir /path/to/generated/ --log-dir /path/to/log --api-spec /path/to/spec.yaml javascript

Build the client and supress Swagger CodeGen CLI command output:

swaggy-c --quiet --api-spec /path/to/spec.yaml javascript

List all available commands for all supported languages:

swaggy-c --help

Configuration

The configuration file that's specified in --conf-file flag should be Swagger CodeGen language configuration file.

Colophon

Developer's Guide

Build reports:

Related Projects:

  • packer-swaggy-c - Packer builder of a Docker image that contains most languages supported by Swagger CodeGen
  • swaggy-jenkins - A set of Jenkins API clients in multiple languages generated from Swagger / Open API specification