oasgraph-cli

v0.4.3

CLI for turning APIs described by OpenAPI Specifications (OAS) into GraphQL interfaces For more information about how to use this package see README

Latest version published 5 years ago

License: MIT

NPM

GitHub

Package Health Score

45 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.4.3	\|	06/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.0	\|	02/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.0	\|	11/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	11/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (8)

GitHub Stars: 1.59K
Forks: 203
Contributors: 30

Direct Usage Popularity

The npm package oasgraph-cli receives a total of 8 downloads a week. As such, we scored oasgraph-cli popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package oasgraph-cli, we found that it has been starred 1,590 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the oasgraph-cli repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like oasgraph-cli is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

deprecated

Commit Frequency

Open Issues: 121
Open PR: 21
Last Release: 5 years ago
Last Commit: 4 months ago

Further analysis of the maintenance status of oasgraph-cli based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for oasgraph-cli is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8

Age: 5 years
Dependencies: 8 Direct
Versions: 10
Install Size: 20.4 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: No

oasgraph-cli has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Travis (.org)

Please note: OASGraph CLI has been renamed to OpenAPI-to-GraphQL CLI.

OASGraph CLI

Command line interface (CLI) for turning APIs described by OpenAPI Specification (OAS) into GraphQL interfaces.

Note: To use OASGraph as a library, refer to the oasgraph package.

Installation

npm i -g oasgraph-cli

Usage

Usage: oasgraph  [options]

Options:
  -V, --version               output the version number
  -p, --port            select the port where the server will start
  -u, --url              select the base url which paths will be built on
  -s, --strict                throw an error if OASGraph cannot run without compensating for errors or missing data in the OAS
  -a, --addSubOperations      nest operations based on path hierarchy
  -f, --fillEmptyResponses    create placeholder schemas for operations with HTTP status code 204 (no response) rather than ignore them
  -o, --operationIdFieldNames  create field names based on the operationId
  --cors                      enable Cross-origin resource sharing (CORS)
  --no-viewer                 do not create GraphQL viewer objects for passing authentication credentials
  --save           save schema to path and do not start server
  -h, --help                  output usage information

The basic usage of the CLI takes the specified OAS, creates a GraphQL interface for it, and starts a server to host the GraphQL interface.

oasgraph oas.json

You can specify the OAS by pointing to either a local file or a remote url such as https://127.0.0.1:3000/openapi.json. Additionally, you can specify a port number so you can have multiple GraphQL servers running on the same machine.

oasgraph https://127.0.0.1:3000/openapi.json -p 3001

OASgraph can also save a GraphQL schema to a local file, which you can use to inspect or change its content. Please note that the following command will not start the GraphQL server.

oasgraph oas.json --save schema.graphql

To learn more about the other options, please refer here.

Please note that the CLI tool is mainly used for quick testing and does not offer all the features that createGraphQlSchema(oas, options) does.

License

MIT

oasgraph-cli dependencies

commander cors express express-graphql graphql js-yaml oasgraph request

oasgraph-cli development dependencies

@types/node jest standard tslint tslint-config-standard typescript

FAQs

What is oasgraph-cli?

CLI for turning APIs described by OpenAPI Specifications (OAS) into GraphQL interfaces. Visit Snyk Advisor to see a full health score report for oasgraph-cli, including popularity, security, maintenance & community analysis.

Is oasgraph-cli popular?

The npm package oasgraph-cli receives a total of 8 weekly downloads. As such, oasgraph-cli popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is oasgraph-cli well maintained?

We found indications that oasgraph-cli is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is oasgraph-cli safe to use?

While scanning the latest version of oasgraph-cli, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 April-2024, at 07:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (8)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Please note: OASGraph CLI has been renamed to OpenAPI-to-GraphQL CLI.

OASGraph CLI

Installation

Usage

License

oasgraph-cli dependencies

oasgraph-cli development dependencies

FAQs

What is oasgraph-cli?

Is oasgraph-cli popular?

Is oasgraph-cli well maintained?

Is oasgraph-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues