Microsoft.OpenApi.Kiota 1.24.0-preview.202502270001

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.24.0-preview.202502270001
                    
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.24.0-preview.202502270001
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Microsoft.OpenApi.Kiota&version=1.24.0-preview.202502270001&prerelease
                    
nuke :add-package Microsoft.OpenApi.Kiota --version 1.24.0-preview.202502270001
                    

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
CLI 🛠️ (see CSharp) + 🛠️ (see CSharp) (see CSharp) (see CSharp) link
CSharp FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
Dart 🛠️ 🛠️ 🛠️ FORM, 🛠️ JSON, 🛠️ MULTIPART, 🛠️ TEXT 🛠️ Anonymous, 🛠️ API Key 🛠️ 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 🛠️
Swift 🛠️ ❌ FORM, ❌ JSON, ❌ FORM, ❌ TEXT Anonymous, ❌ Azure
TypeScript/JavaScript 🛠️ 🛠️ FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure, SPFx 🛠️ link

Legend: ✔ → stable, 🛠️ → 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 net8.0 is compatible.  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 is compatible.  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.27.0-preview.202505220001 113 5/22/2025
1.26.1 8,548 5/16/2025
1.26.0 6,745 5/6/2025
1.25.1 20,818 4/4/2025
1.25.1-preview.202505010001 119 5/1/2025
1.25.1-preview.202504240001 150 4/24/2025
1.25.1-preview.202504170001 170 4/17/2025
1.25.1-preview.202504100001 152 4/10/2025
1.24.3 15,616 3/26/2025
1.24.2 914 3/26/2025
1.24.1 6,582 3/13/2025
1.24.0 10,427 3/12/2025
1.24.0-preview.202503060001 227 3/6/2025
1.24.0-preview.202502270001 147 2/27/2025
1.24.0-preview.202502200001 81 2/27/2025
1.24.0-preview.202502130001 76 2/27/2025
1.23.0 28,506 2/7/2025
1.23.0-preview.202501300001 115 1/31/2025
1.22.3 17,376 1/15/2025
1.22.2 6,061 1/13/2025
1.22.1 832 1/10/2025
1.22.0 16,309 1/9/2025
1.22.0-preview.202412260001 166 12/27/2024
1.22.0-preview.202412190001 94 12/19/2024
1.22.0-preview.202412120001 124 12/12/2024
1.21.0 23,261 12/5/2024
1.21.0-preview.202411290004 83 11/29/2024
1.21.0-preview.202411290003 78 11/29/2024
1.21.0-preview.202411290002 82 11/29/2024
1.21.0-preview.202411210001 90 11/22/2024
1.21.0-preview.202411140001 90 11/15/2024
1.20.0 32,236 11/7/2024
1.20.0-preview.202410240001 104 10/24/2024
1.20.0-preview.202410170001 112 10/18/2024
1.20.0-preview.202410100001 90 10/10/2024
1.19.1 23,614 10/11/2024
1.19.0 14,863 10/3/2024
1.19.0-preview.202409260001 80 9/26/2024
1.19.0-preview.202409200002 84 9/20/2024
1.19.0-preview.202409190001 72 9/20/2024
1.19.0-preview.202409120001 123 9/12/2024
1.18.0 30,918 9/5/2024
1.18.0-preview.202408290001 103 8/29/2024
1.18.0-preview.202408220001 102 8/22/2024
1.18.0-preview.202408150001 174 8/15/2024
1.17.0 13,870 8/9/2024
1.17.0-preview.202408010001 69 8/1/2024
1.16.0 23,090 7/5/2024
1.16.0-preview.202406270001 91 6/27/2024
1.16.0-preview.202406200001 87 6/21/2024
1.16.0-preview.202406130001 81 6/13/2024
1.15.0 61,729 6/6/2024
1.15.0-preview.202405300001 102 5/31/2024
1.15.0-preview.202405230001 134 5/23/2024
1.15.0-preview.202405160001 126 5/16/2024
1.15.0-preview.202405090001 109 5/9/2024
1.14.0 22,993 5/2/2024
1.14.0-preview.202404250001 111 4/25/2024
1.14.0-preview.202404180001 114 4/18/2024
1.14.0-preview.202404110001 111 4/12/2024
1.13.0 45,265 4/4/2024
1.13.0-preview.202403280001 177 3/28/2024
1.13.0-preview.202403210001 451 3/21/2024
1.12.0 21,628 3/7/2024
1.12.0-preview.202403040006 101 3/4/2024
1.12.0-preview.202402290001 119 2/29/2024
1.12.0-preview.202402220002 108 2/22/2024
1.11.1 14,603 2/5/2024
1.11.1-preview.202402220001 87 2/22/2024
1.11.1-preview.202402150001 93 2/15/2024
1.11.1-preview.202402080001 90 2/8/2024
1.11.0 2,117 2/1/2024
1.11.0-preview.202401300001 99 1/30/2024
1.10.1 11,898 1/12/2024
1.10.0 841 1/11/2024
1.10.0-preview.202312210001 201 12/22/2023
1.9.1 12,387 12/13/2023
1.9.0 2,977 12/7/2023
1.9.0-preview.202311300001 146 11/30/2023
1.9.0-preview.202311230001 114 11/23/2023
1.9.0-preview.202311160001 107 11/16/2023
1.8.2 19,887 11/8/2023
1.8.1 9,493 11/2/2023
1.8.0 817 11/2/2023
1.8.0-preview.202310260001 134 10/26/2023
1.8.0-preview.202310190001 104 10/19/2023
1.8.0-preview.202310120001 108 10/12/2023
1.7.0 14,235 10/5/2023
1.7.0-preview.202309280001 101 9/28/2023
1.7.0-preview.202309210001 117 9/21/2023
1.6.1 13,386 9/11/2023
1.6.0-preview.202309070001 116 9/7/2023
1.6.0-preview.202308310001 137 8/31/2023
1.6.0-preview.202308240001 124 8/24/2023
1.5.1 9,959 8/9/2023
1.5.0 2,401 8/4/2023
1.5.0-preview.202308030001 133 8/3/2023
1.5.0-preview.202307270001 127 7/27/2023
1.5.0-preview.202307200001 4,574 7/20/2023
1.5.0-preview.202307170006 128 7/17/2023
1.4.0 9,538 7/10/2023
1.4.0-preview.202307140002 117 7/14/2023
1.4.0-preview.202307140001 127 7/14/2023
1.4.0-preview.202307130012 126 7/13/2023
1.4.0-preview.202307130004 122 7/13/2023
1.4.0-preview.202307130003 121 7/13/2023
1.3.0 11,880 6/9/2023
1.2.1 6,459 5/17/2023
1.2.0 2,848 5/4/2023
1.1.3 13,952 4/18/2023
1.1.2 680 4/17/2023
1.1.1 3,297 4/5/2023
1.1.0 682 4/5/2023
1.0.1 9,064 3/9/2023
1.0.0 673 3/9/2023
0.11.1-preview 7,051 2/13/2023
0.11.0-preview 1,842 2/7/2023
0.10.0-preview 3,115 1/4/2023
0.9.0-preview 540 12/19/2022
0.8.3-preview 524 12/1/2022
0.7.1-preview 544 11/1/2022
0.6.0-preview 539 10/7/2022
0.5.1-preview 620 9/9/2022
0.5.0-preview 618 9/8/2022
0.4.0-preview 618 8/18/2022
0.3.0-preview 706 7/8/2022
0.2.1-preview 728 5/30/2022
0.2.0-preview 627 5/24/2022
0.1.3-preview 581 5/9/2022
0.1.2-preview 675 5/9/2022
0.1.1-preview 797 5/6/2022
0.1.0-preview 747 5/5/2022