Skip to content

Mermade/openapi-extract

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Apr 20, 2023
0063ba4 · Apr 20, 2023

History

56 Commits
Apr 2, 2023
Apr 10, 2023
Apr 20, 2023
Jan 22, 2018
Jan 10, 2021
Apr 20, 2023
Jan 22, 2018
Apr 20, 2023
Apr 20, 2023
Apr 20, 2023
Apr 20, 2023
Apr 20, 2023

Repository files navigation

openapi-extract

ci

Extract paths, operations, parameters, schemas etc from OpenAPI/Swagger definitions.

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

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

Options:
  -h, --help             Show help                                     [boolean]
  --version              Show version number                           [boolean]
  --openai               make the definition OpenAI compliant          [boolean]
  --server               include server information                    [boolean]
  --shard                shard the input to an output directory         [string]
  -p, --path             the path to extract                            [string]
  -o, --operationid      the operationIds to extract                     [array]
  -m, --method           the method to extract for the given path       [string]
  -i, --info             copy full info object, otherwise minimal      [boolean]
  -d, --removeDocs       remove all externalDocs properties            [boolean]
  -r, --removeExamples   remove all example/examples properties        [boolean]
  -x, --removeExtensions remove all x- extension properties            [boolean]
  -s, --security         include security information                  [boolean]
  -v, --verbose          increase verbosity                            [boolean]

or

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

const map = openapiExtractor.shard(obj, options);

The options object takes the same values as the CLI, for these keys and default values:

  • path = ''
  • method = ''
  • info = false
  • openai = false
  • removeDocs = false
  • removeExamples = false
  • removeExtensions = false
  • server = false
  • security = false
  • operationid = []

OpenAI compliant mode

This option turns on the following rules:

  1. The description properties must have a maximum length of 300 characters