JSPM

openapi-graph-cli

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q27018F
  • License MIT

A cli to manage analyze API projects defined by OpenAPIv3 specification.

Package Exports

  • openapi-graph-cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (openapi-graph-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenAPI-graph-cli

A cli to analyze your OpenAPI specifications. Yes, specifications. This means that if you have a huge project that is heavily using OpenAPI $ref to import external schemas, requestBodies, paths... then it is very difficult for you to mantain such a large project and for example, you might have some schemas that are not being used.

With this cli, you can analyze different aspects and helping you maintain your big project.

Installation

Run

npm install -g openapi-graph-cli

And then you can run the analyzer

Analyzer

Run

apig analyze [PATH [OPTIONS]]

The PATH is the common root path for all your APIs. For example, if you have a project like the social network shown here, the path could be /tests/resources/social-network or . if you are already in the folder.

Options

You can use --verbose or --debug mode