Openapi3Invoker

This gem builds off of (openapi3_parser)[https://github.com/kevindew/openapi3_parser] to enable simple calling of OpenAPI operations.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add openapi3_invoker

If bundler is not being used to manage dependencies, install the gem by executing:

gem install openapi3_invoker

Usage

openapi_parser = Openapi3Parser.load(open_api_definition)
path = "/api/function/name"
http_method = "get"
parameters = { "some" => "parameter" }
openapi_invoker = Openapi3Invoker.new(openapi_definition, base_url: tool.tool_set.base_url)
status, headers, result = openapi_invoker.invoke(path, http_method, parameters: parameters)

Development

All development must be done in a pull request and approved before merging.

To run the specs do the following: rake spec

Releasing

To release, first increment the version file, then cut a new tag of the form v#.#.#.

For example:

git tag v0.2.0 -f
git push --tags -f

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openapi3_invoker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Openapi3Invoker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.