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

jsspbuilder

v1.0.26

Published

A CLI to generate K2 JSSP Broker Code from a Swagger/OpenAPI definition file.

Downloads

2

Vulnerabilities

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

Links

Maintainers

smiddiezasmiddieza

Keywords

Readme

K2 TypeScript Broker Generator

This is a CLI which can be used to generate a K2 Broker by providing a Swagger v2.0 or OpenAPI v3.0 definition as input.

Features

  • Generates a TypeScript code file (index.ts) from a Swagger v2.0 or OpenAPI v3.0 definition file (json format)

  • Dynamic flattening of complex objects up to user defined level in describe schema

  • Dynamic flattening of returned data for complex objects

Getting Started

This CLI requires Node.js v12.14.1+ to run.

Usage

  1. Clone the K2 JavaScript broker template into a new directory:
git clone https://github.com/K2Documentation/K2Documentation.Samples.JavascriptBroker.Template.git mynewbroker

cd mynewbroker
  1. Install K2 Broker dependencies:
npm install
  1. Install the JSSPBuilder CLI globally:
npm install jsspbuilder -g
  1. Copy/Save you swagger/openAPI definition file to the project folder
copy [your_definition_file] swagger.json

Note: If you want to integrate with an OData v4.0 service, you can make use of our OData v4.0 to >OpenAPI v3.0 conversion service. The Service can be found at: https://odata4edmtoopenapi3converter.azurewebsites.net/swagger/index.html

  1. Run the JSSPBuilder CLI:

Interactive...

jsspbuilder

or with parameters

jsspbuilder --filename=swagger.json --flatten=2 --outputdir=src

Note: If an index.ts file existed before running jsspbuilder, it will be renamed index.ts_bak1

  1. Follow the instructions to build and publish your broker to a K2 Cloud instance :
    https://www.npmjs.com/package/@k2oss/k2-broker-core