Kiota SDK for Ruby

This repository contains the Ruby libraries for Kiota-generated API clients.

Ruby 3.3 or newer is required.

Gem	Description	RubyGems
microsoft_kiota_abstractions	Core abstractions for Kiota-generated clients
microsoft_kiota_serialization_json	JSON serialization implementation
microsoft_kiota_faraday	HTTP client implementation with Faraday
microsoft_kiota_authentication_oauth	OAuth authentication provider

Add the gems you need to your application's Gemfile:

gem 'microsoft_kiota_abstractions'
gem 'microsoft_kiota_serialization_json'
gem 'microsoft_kiota_faraday'
gem 'microsoft_kiota_authentication_oauth'

Install Ruby 3.3 or newer, then run:

git clone https://github.com/microsoft/kiota-ruby.git
cd kiota-ruby
bundle install
rake spec        # run all tests
rake rubocop     # run linter

To run tests for a specific component:

rake abstractions:spec
rake serialization-json:spec
rake http:spec
rake authentication-oauth:spec

To auto-fix formatting issues:

bundle exec rubocop -a

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.