A TS library to manage large API projects defined by OpenAPIv3 specification.
Just run
npm install openapi-graph-core
and you are good to go.
This README.md is only for the API of this library. You can check the cli to run it in the console here
OpenAPI-graph provide two major classes that are accesible called: OpenAPIGraphs and Analyzer.
This class will create the graphs of the APIs. You can provide a root path, which will be used to look for the API specifications. For example, a valid root path if we use one of the examples would be:
constOpenAPIGrahCore=require('openapi-graph-core');(async()=>{constgraphs=awaitnewOpenAPIGrahCore.OpenAPIGraphs('./tests/resources/social-network').build()/* It will return { "social-network.yaml": { Omitting graph ... }, "./posts/posts.yaml": { Omitting graph ... }, "./users/users.yaml": { Omitting graph ... }, } */})();It will analyze the graphs checking different conditions. You can initiazlie as follows (you need to initialize OpenAPIGrahps):
constOpenAPIGrahCore=require('openapi-graph-core');(async()=>{constgraphs=awaitnewOpenAPIGrahCore.OpenAPIGraphs('./tests/resources/social-network').build()constanalyzer=OpenAPIGrahCore.Analyzer(graphs)})();For now, these function have been developed:
| Function | Description | Returns |
|---|---|---|
| getUnusedSchemas() | It will check all the schemas declared but not being used in the components.schemas container | JSON |
| getDeprecatedSchemasBeingUsed() | It will check all the deprecated schemas declared being in used | JSON |