Microsoft.OpenApi.Kiota 1.19.0

Prefix Reserved
dotnet tool install --global Microsoft.OpenApi.Kiota --version 1.19.0                
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.19.0                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Microsoft.OpenApi.Kiota&version=1.19.0                
nuke :add-package Microsoft.OpenApi.Kiota --version 1.19.0                

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 🛠️
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, 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. 
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.19.0 0 10/3/2024
1.19.0-preview.202409260001 49 9/26/2024
1.19.0-preview.202409200002 59 9/20/2024
1.19.0-preview.202409190001 41 9/20/2024
1.19.0-preview.202409120001 98 9/12/2024
1.18.0 14,527 9/5/2024
1.18.0-preview.202408290001 86 8/29/2024
1.18.0-preview.202408220001 87 8/22/2024
1.18.0-preview.202408150001 155 8/15/2024
1.17.0 12,001 8/9/2024
1.17.0-preview.202408010001 49 8/1/2024
1.16.0 14,725 7/5/2024
1.16.0-preview.202406270001 69 6/27/2024
1.16.0-preview.202406200001 70 6/21/2024
1.16.0-preview.202406130001 65 6/13/2024
1.15.0 30,746 6/6/2024
1.15.0-preview.202405300001 85 5/31/2024
1.15.0-preview.202405230001 113 5/23/2024
1.15.0-preview.202405160001 111 5/16/2024
1.15.0-preview.202405090001 93 5/9/2024
1.14.0 21,107 5/2/2024
1.14.0-preview.202404250001 94 4/25/2024
1.14.0-preview.202404180001 94 4/18/2024
1.14.0-preview.202404110001 97 4/12/2024
1.13.0 27,300 4/4/2024
1.13.0-preview.202403280001 163 3/28/2024
1.13.0-preview.202403210001 425 3/21/2024
1.12.0 20,118 3/7/2024
1.12.0-preview.202403040006 84 3/4/2024
1.12.0-preview.202402290001 102 2/29/2024
1.12.0-preview.202402220002 88 2/22/2024
1.11.1 13,864 2/5/2024
1.11.1-preview.202402220001 67 2/22/2024
1.11.1-preview.202402150001 72 2/15/2024
1.11.1-preview.202402080001 67 2/8/2024
1.11.0 2,075 2/1/2024
1.11.0-preview.202401300001 80 1/30/2024
1.10.1 11,452 1/12/2024
1.10.0 803 1/11/2024
1.10.0-preview.202312210001 182 12/22/2023
1.9.1 9,634 12/13/2023
1.9.0 2,936 12/7/2023
1.9.0-preview.202311300001 130 11/30/2023
1.9.0-preview.202311230001 96 11/23/2023
1.9.0-preview.202311160001 89 11/16/2023
1.8.2 18,358 11/8/2023
1.8.1 9,274 11/2/2023
1.8.0 777 11/2/2023
1.8.0-preview.202310260001 118 10/26/2023
1.8.0-preview.202310190001 81 10/19/2023
1.8.0-preview.202310120001 90 10/12/2023
1.7.0 13,901 10/5/2023
1.7.0-preview.202309280001 81 9/28/2023
1.7.0-preview.202309210001 88 9/21/2023
1.6.1 13,344 9/11/2023
1.6.0-preview.202309070001 94 9/7/2023
1.6.0-preview.202308310001 116 8/31/2023
1.6.0-preview.202308240001 99 8/24/2023
1.5.1 9,908 8/9/2023
1.5.0 2,374 8/4/2023
1.5.0-preview.202308030001 110 8/3/2023
1.5.0-preview.202307270001 105 7/27/2023
1.5.0-preview.202307200001 4,553 7/20/2023
1.5.0-preview.202307170006 103 7/17/2023
1.4.0 9,329 7/10/2023
1.4.0-preview.202307140002 92 7/14/2023
1.4.0-preview.202307140001 101 7/14/2023
1.4.0-preview.202307130012 99 7/13/2023
1.4.0-preview.202307130004 101 7/13/2023
1.4.0-preview.202307130003 98 7/13/2023
1.3.0 11,786 6/9/2023
1.2.1 6,431 5/17/2023
1.2.0 2,811 5/4/2023
1.1.3 13,915 4/18/2023
1.1.2 651 4/17/2023
1.1.1 3,239 4/5/2023
1.1.0 650 4/5/2023
1.0.1 9,031 3/9/2023
1.0.0 587 3/9/2023
0.11.1-preview 7,025 2/13/2023
0.11.0-preview 1,816 2/7/2023
0.10.0-preview 3,084 1/4/2023
0.9.0-preview 511 12/19/2022
0.8.3-preview 491 12/1/2022
0.7.1-preview 514 11/1/2022
0.6.0-preview 509 10/7/2022
0.5.1-preview 589 9/9/2022
0.5.0-preview 581 9/8/2022
0.4.0-preview 583 8/18/2022
0.3.0-preview 674 7/8/2022
0.2.1-preview 693 5/30/2022
0.2.0-preview 591 5/24/2022
0.1.3-preview 530 5/9/2022
0.1.2-preview 624 5/9/2022
0.1.1-preview 765 5/6/2022
0.1.0-preview 696 5/5/2022