module Openapi3Parser

For a variety of inputs this will construct an OpenAPI document. For a String/File input it will try to determine if the input is JSON or YAML.

@param [String, Hash, File] input Source for the OpenAPI document

@return [Document]

# File lib/openapi3_parser.rb, line 13
def self.load(input)
  Document.new(SourceInput::Raw.new(input))
end

For a given string filename this will read the file and parse it as an OpenAPI document. It will try detect automatically whether the contents are JSON or YAML.

@param [String] path Filename of the OpenAPI document

@return [Document]

# File lib/openapi3_parser.rb, line 24
def self.load_file(path)
  Document.new(SourceInput::File.new(path))
end

For a given string URL this will request the resource and parse it as an OpenAPI document. It will try detect automatically whether the contents are JSON or YAML.

@param [String] url URL of the OpenAPI document

@return [Document]

# File lib/openapi3_parser.rb, line 35
def self.load_url(url)
  Document.new(SourceInput::Url.new(url.to_s))
end