Microsoft.OpenApi.Kiota 1.8.0-preview.202310120001

Prefix Reserved
This is a prerelease version of Microsoft.OpenApi.Kiota.
There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global Microsoft.OpenApi.Kiota --version 1.8.0-preview.202310120001
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local Microsoft.OpenApi.Kiota --version 1.8.0-preview.202310120001
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Microsoft.OpenApi.Kiota&version=1.8.0-preview.202310120001&prerelease
                    
nuke :add-package Microsoft.OpenApi.Kiota --version 1.8.0-preview.202310120001
                    

Project

Dotnet CodeQL Coverage Sonarcloud Status

Kiota is a command line tool for generating an API client to call any OpenAPI described API you are interested in. The goal is to eliminate the need to take a dependency on a different API SDK for every API that you need to call. Kiota API clients provide a strongly typed experience with all the features you expect from a high quality API SDK, but without having to learn a new library for every HTTP API.

This library builds on top of the Microsoft.OpenAPI.NET library to ensure comprehensive support for APIs that use OpenAPI descriptions. One of the goals of the project is to provide the best code generator support possible for OpenAPI and JSON Schema features. The conceptual documentation describes how kiota works and the high level concepts, this readme documents how to get started with Kiota.

Getting started

Generating SDKs

  1. Install required tools and dependencies. (refer to the Supported Languages table under the Required tools & dependencies column)
  2. Get Kiota using one of the available options.
  3. Generate your API client, checkout the Parameters reference for the different options.
  4. Start calling your API using your fluent API Client.

Supported languages

The following table provides an overview of the languages supported by Kiota and the progress in the implementation of the different components.

Language Generation Abstractions Serialization Authentication HTTP Required tools & dependencies
CSharp FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
Go FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
Java FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
PHP JSON, ❌ FORM, ❌ MULTIPART, TEXT Anonymous, ✔️ PHP League link
Python ❌ FORM, JSON, ❌ MULTIPART, TEXT Anonymous, Azure link
Ruby ❌ FORM, JSON, ❌ MULTIPART, ❌ TEXT Anonymous, ✔️ OAuth2 link
CLI (see CSharp) + (see CSharp) (see CSharp) (see CSharp) link
Swift ❌ FORM, ❌ JSON, ❌ FORM, ❌ TEXT Anonymous, ❌ Azure
TypeScript/JavaScript FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link

Legend: ✔ → in preview, ❌ → not started, ▶ → in progress.

Parameters reference

Parameters are documented here.

Debugging

Make sure you install the pre-requisites first. If you are using Visual Studio Code as your IDE, the launch.json file already contains the configuration to run Kiota. By default this configuration will use the openApiDocs/v1.0/Mail.yml under the PowerShell repository as the OpenAPI to generate an SDK for. By default this configuration will output the generated files in a graphdotnetv4|graphjavav4|graphtypescriptv4 folder located in the parent folder this repository is cloned in.

Selecting the language you want to generate an API client for in the Visual Studio Debug tab and hitting F5 will automatically build, start, and attach the debugging process to Kiota.

Samples

You can find samples of clients generated with Kiota in the Kiota samples repository.

An example of an application that is calling multiple API can be found in the KiotaApp repo

Contributing

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.

Trademarks

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.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
1.28.0 77,921 7/11/2025
1.27.0 28,583 6/11/2025
1.27.0-preview.202506050001 163 6/5/2025
1.27.0-preview.202505290001 171 5/29/2025
1.27.0-preview.202505220001 154 5/22/2025
1.26.1 31,192 5/16/2025
1.26.0 17,391 5/6/2025
1.25.1 27,389 4/4/2025
1.25.1-preview.202505010001 158 5/1/2025
1.25.1-preview.202504240001 186 4/24/2025
1.25.1-preview.202504170001 193 4/17/2025
1.25.1-preview.202504100001 182 4/10/2025
1.24.3 43,057 3/26/2025
1.24.2 3,546 3/26/2025
1.24.1 13,536 3/13/2025
1.24.0 13,118 3/12/2025
1.24.0-preview.202503060001 254 3/6/2025
1.24.0-preview.202502270001 184 2/27/2025
1.24.0-preview.202502200001 105 2/27/2025
1.24.0-preview.202502130001 114 2/27/2025
1.23.0 41,522 2/7/2025
1.23.0-preview.202501300001 150 1/31/2025
1.22.3 28,577 1/15/2025
1.22.2 12,493 1/13/2025
1.22.1 3,464 1/10/2025
1.22.0 18,925 1/9/2025
1.22.0-preview.202412260001 208 12/27/2024
1.22.0-preview.202412190001 127 12/19/2024
1.22.0-preview.202412120001 158 12/12/2024
1.21.0 29,316 12/5/2024
1.21.0-preview.202411290004 121 11/29/2024
1.21.0-preview.202411290003 115 11/29/2024
1.21.0-preview.202411290002 113 11/29/2024
1.21.0-preview.202411210001 121 11/22/2024
1.21.0-preview.202411140001 118 11/15/2024
1.20.0 35,273 11/7/2024
1.20.0-preview.202410240001 145 10/24/2024
1.20.0-preview.202410170001 143 10/18/2024
1.20.0-preview.202410100001 125 10/10/2024
1.19.1 27,916 10/11/2024
1.19.0 17,778 10/3/2024
1.19.0-preview.202409260001 118 9/26/2024
1.19.0-preview.202409200002 123 9/20/2024
1.19.0-preview.202409190001 116 9/20/2024
1.19.0-preview.202409120001 160 9/12/2024
1.18.0 38,802 9/5/2024
1.18.0-preview.202408290001 140 8/29/2024
1.18.0-preview.202408220001 122 8/22/2024
1.18.0-preview.202408150001 214 8/15/2024
1.17.0 16,638 8/9/2024
1.17.0-preview.202408010001 98 8/1/2024
1.16.0 30,862 7/5/2024
1.16.0-preview.202406270001 126 6/27/2024
1.16.0-preview.202406200001 120 6/21/2024
1.16.0-preview.202406130001 118 6/13/2024
1.15.0 73,981 6/6/2024
1.15.0-preview.202405300001 135 5/31/2024
1.15.0-preview.202405230001 164 5/23/2024
1.15.0-preview.202405160001 165 5/16/2024
1.15.0-preview.202405090001 146 5/9/2024
1.14.0 25,912 5/2/2024
1.14.0-preview.202404250001 143 4/25/2024
1.14.0-preview.202404180001 147 4/18/2024
1.14.0-preview.202404110001 150 4/12/2024
1.13.0 53,081 4/4/2024
1.13.0-preview.202403280001 207 3/28/2024
1.13.0-preview.202403210001 488 3/21/2024
1.12.0 24,314 3/7/2024
1.12.0-preview.202403040006 137 3/4/2024
1.12.0-preview.202402290001 148 2/29/2024
1.12.0-preview.202402220002 140 2/22/2024
1.11.1 17,111 2/5/2024
1.11.1-preview.202402220001 118 2/22/2024
1.11.1-preview.202402150001 125 2/15/2024
1.11.1-preview.202402080001 127 2/8/2024
1.11.0 4,624 2/1/2024
1.11.0-preview.202401300001 134 1/30/2024
1.10.1 14,686 1/12/2024
1.10.0 3,357 1/11/2024
1.10.0-preview.202312210001 235 12/22/2023
1.9.1 14,906 12/13/2023
1.9.0 5,481 12/7/2023
1.9.0-preview.202311300001 182 11/30/2023
1.9.0-preview.202311230001 147 11/23/2023
1.9.0-preview.202311160001 143 11/16/2023
1.8.2 22,492 11/8/2023
1.8.1 12,162 11/2/2023
1.8.0 3,322 11/2/2023
1.8.0-preview.202310260001 169 10/26/2023
1.8.0-preview.202310190001 142 10/19/2023
1.8.0-preview.202310120001 147 10/12/2023
1.7.0 16,763 10/5/2023
1.7.0-preview.202309280001 140 9/28/2023
1.7.0-preview.202309210001 162 9/21/2023
1.6.1 15,898 9/11/2023
1.6.0-preview.202309070001 173 9/7/2023
1.6.0-preview.202308310001 182 8/31/2023
1.6.0-preview.202308240001 173 8/24/2023
1.5.1 12,504 8/9/2023
1.5.0 4,934 8/4/2023
1.5.0-preview.202308030001 183 8/3/2023
1.5.0-preview.202307270001 183 7/27/2023
1.5.0-preview.202307200001 4,639 7/20/2023
1.5.0-preview.202307170006 182 7/17/2023
1.4.0 12,118 7/10/2023
1.4.0-preview.202307140002 173 7/14/2023
1.4.0-preview.202307140001 188 7/14/2023
1.4.0-preview.202307130012 193 7/13/2023
1.4.0-preview.202307130004 174 7/13/2023
1.4.0-preview.202307130003 180 7/13/2023
1.3.0 14,419 6/9/2023
1.2.1 8,990 5/17/2023
1.2.0 5,387 5/4/2023
1.1.3 16,488 4/18/2023
1.1.2 3,254 4/17/2023
1.1.1 5,833 4/5/2023
1.1.0 3,211 4/5/2023
1.0.1 11,598 3/9/2023
1.0.0 3,226 3/9/2023
0.11.1-preview 7,136 2/13/2023
0.11.0-preview 1,933 2/7/2023
0.10.0-preview 3,198 1/4/2023
0.9.0-preview 623 12/19/2022
0.8.3-preview 601 12/1/2022
0.7.1-preview 624 11/1/2022
0.6.0-preview 625 10/7/2022
0.5.1-preview 702 9/9/2022
0.5.0-preview 709 9/8/2022
0.4.0-preview 708 8/18/2022
0.3.0-preview 802 7/8/2022
0.2.1-preview 817 5/30/2022
0.2.0-preview 709 5/24/2022
0.1.3-preview 669 5/9/2022
0.1.2-preview 767 5/9/2022
0.1.1-preview 891 5/6/2022
0.1.0-preview 843 5/5/2022