JSPM

openapi-extract

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2510
  • Score
    100M100P100Q114886F
  • License BSD-3-Clause

extract paths or operations from OpenAPI/Swagger definitions

Package Exports

  • openapi-extract

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-extract) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

openapi-extract

extract paths, operations, parameters, schemas etc from OpenAPI/Swagger definitions

Works with OpenAPI/Swagger 2.0 and 3.0.x definitions.

Usage: openapi-extract [options] {infile} [{outfile}]

Options:
  -h, --help         Show help                                         [boolean]
  --version          Show version number                               [boolean]
  --server           include server information                        [boolean]
  -p, --path         the path to extract                                [string]
  -o, --operationid  the operationId to extract                         [string]
  -m, --method       the method to extract for the given path           [string]
  -i, --info         copy full info object, otherwise minimal          [boolean]
  -s, --security     include security information                      [boolean]
  -v, --verbose      increase verbosity                                [boolean]

or

let openapiExtractor = require('openapi-extract');
let options = {};
// options.path = '...';
// options.method = '...';
// options.operationid = '...';
let res = openapiExtractor.extract(obj,options);