OpenAPI based HTTP Client code generator
Перейти к файлу
Vincent Biret 46ece29526
Merge pull request #6069 from microsoft/dependabot/pip/it/python/isort-6.0.0
chore(deps-dev): bump isort from 5.13.2 to 6.0.0 in /it/python
2025-01-29 06:40:34 -05:00
.azure-pipelines Include all files 2025-01-27 13:19:50 +03:00
.devcontainer - fixes variant name 2024-03-22 14:49:19 -04:00
.github chore(deps): bump docker/build-push-action from 6.12.0 to 6.13.0 2025-01-28 09:17:37 +00:00
.vscode Merge branch 'main' into feature/http-language-support 2025-01-20 15:49:13 +03:00
abstractions feat: moves swift abstractions to microsoft/kiota-swift for sanity 2024-07-23 09:22:01 -04:00
authentication - removes ruby libraries after their publishing 2022-12-30 17:10:33 -05:00
docs Update docs/404.md 2023-03-29 13:44:35 -04:00
guardian/SDL/common security/pipeline compliance (#4137) 2024-03-06 13:53:44 +03:00
http - removes ruby libraries after their publishing 2022-12-30 17:10:33 -05:00
intellij Deleted the files under .github directory and todolist.md file 2023-09-06 14:52:54 -07:00
it chore(deps-dev): bump isort from 5.13.2 to 6.0.0 in /it/python 2025-01-29 10:44:40 +00:00
resources Revert "Merge pull request #5025 from microsoft/andrueastman/defaultIcons" 2024-08-19 16:04:43 +03:00
scripts Merge remote-tracking branch 'origin/main' into andrueastman/net9tool 2025-01-15 12:32:58 +03:00
serialization - removes ruby libraries after their publishing 2022-12-30 17:10:33 -05:00
specs Fix VSCode's extension update (#5514) 2024-10-03 19:15:53 +03:00
src Update src/Kiota.Builder/Writers/HTTP/CodeClassDeclarationWriter.cs 2025-01-22 10:35:25 +03:00
tests Merge branch 'main' into feature/http-language-support 2025-01-20 15:49:13 +03:00
vscode/microsoft-kiota chore(deps-dev): bump @types/node in /vscode/microsoft-kiota 2025-01-28 09:17:21 +00:00
.editorconfig - adds suppressions for generated code 2023-06-14 13:25:49 -04:00
.gitattributes update vscode logo (#5408) 2024-09-12 22:07:09 +03:00
.gitignore Fix idempotency test results upload 2023-09-21 12:59:43 +01:00
CHANGELOG.md chore: adds missing changelog entry for net9 support 2025-01-28 07:40:57 -05:00
CODE_OF_CONDUCT.md - udpates code of conduct to latest version 2024-05-14 07:38:01 -04:00
CONTRIBUTING.md Improve CONTRIBUTING.md 2024-03-26 11:37:33 +01:00
Dockerfile chore: fix typo in docker file 2025-01-14 16:17:40 +03:00
LICENSE Updating LICENSE to template content 2020-12-22 07:49:33 -08:00
README.md Sort languages alphabetically 2024-11-15 18:54:19 +01:00
SECURITY.md Initial SECURITY.md commit 2020-12-22 07:49:36 -08:00
SUPPORT.md More docs updates 2021-02-28 11:08:29 -05:00
global.json fix: sets a version compatible with linux installations 2024-10-15 08:21:56 -04:00
kiota.sln - removes kiota web projects 2023-07-17 14:49:21 -04:00

README.md

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 🛠️
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.