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

@mindbaz/sweego-openapi-spec-generator

v0.0.5

Published

Generate yaml and/or json openapi specification file

Downloads

16

Readme

Swego-openapi-spec-generator

This module aims to replace an old yaml file generation for sweego learn doc.
As we want to automatically generate sdks for sweego apis it was needed to export/upgrade this part

What for?

This project generates openapi spec file from combined apis.
Openapi spec file can be generated in json or yaml.

Requirements

You need to have an environement file in order to specify 2 things :

  • your primary api url
  • your secondary api url

| Env File | |----------|

{
    "API_SI_URL": "<PRIMARY_API>/openapi.json",
    "API_CLIENT_URL": "<SECONDARY_API>/openapi.json"
}

Using the entrypoints

In a node project

npm i @mindbaz/sweego-openapi-spec-generator --save-dev

| package.json | |-|

  "scripts": {
    ...,
    "spec-generate": "sweego-openapi-spec-generator"
    ...
  }
# Exported as yaml file
npm run spec-generate -- yaml <ENV_FILE_PATH> <PATH_TO_EXPORT_DIR>

# Exported as json file
npm run spec-generate -- json <ENV_FILE_PATH> <PATH_TO_EXPORT_DIR>

As a cli

npm i -g @mindbaz/sweego-openapi-spec-generator
sweego-openapi-spec-generator <EXPORT_TYPE> <ENV_FILE_PATH> <PATH_TO_EXPORT_DIR>

Using the lib

npm i @mindbaz/sweego-openapi-spec-generator --save-dev
const swgSpecGenerator = require ('sweego-openapi-spec-generator');

// Returned as json object
const res = swgSpecGenerator.genOpenapiSpec ('json', '/path/to/env/file',);

// Exported as yaml file
swgSpecGenerator.genOpenapiSpec ('yaml', '/path/to/env/file', '/path/to/export/dir/');