kiota

Проект

Kiota — это инструмент командной строки для создания API-клиента для вызова любого интересующего вас API, описанного OpenAPI. Цель состоит в том, чтобы исключить необходимость зависимости от другого API SDK для каждого API, который вам нужно вызвать. Клиенты Kiota API предоставляют строго типизированный интерфейс со всеми функциями, которые вы ожидаете от высококачественного API SDK, но без необходимости изучать новую библиотеку для каждого HTTP API.

Эта библиотека создана на основе библиотеки Microsoft.OpenAPI.NET и обеспечивает всестороннюю поддержку API, использующих описания OpenAPI. Одна из целей проекта — обеспечить наилучшую возможную поддержку генератора кода для функций OpenAPI и JSON Schema. Концептуальная документация описывает, как работает kiota, и концепции высокого уровня. В этом файле readme описано, как начать работу с Kiota.

Начиная

Создание SDK

1. Установите необходимые инструменты и зависимости. (см. таблицу «Поддерживаемые языки» в столбце «Требуемые инструменты и зависимости» )
2. Получите Киоту, воспользовавшись одним из доступных вариантов.
3. Создайте свой API-клиент, ознакомьтесь со справочником параметров, чтобы узнать о различных параметрах.
4. Начните вызывать свой API, используя свободный API-клиент.

Поддерживаемые языки

В следующей таблице представлен обзор языков, поддерживаемых Kiota, и прогресс в реализации различных компонентов.

Язык	Поколение	Абстракции	Сериализация	Аутентификация	HTTP	Необходимые инструменты и зависимости
интерфейс командной строки		(см. CSharp) +	(см. CSharp)	(см. CSharp)	(см. CSharp)	связь
CSharp	✔	✔	ФОРМА, JSON, МНОГОЧАСТНЫЙ, ТЕКСТ	Анонимно, ключ API, Azure	✔	связь
Дарт	▶		ФОРМА, ▶ JSON, ▶ MULTIPART, ТЕКСТ	Анонимно, ключ API
Идти	✔	✔	ФОРМА, JSON, МНОГОЧАСТНЫЙ, ТЕКСТ	Анонимно, ключ API, Azure	✔	связь
Ява	✔	✔	ФОРМА, JSON, МНОГОЧАСТНЫЙ, ТЕКСТ	Анонимно, ключ API, Azure	✔	связь
PHP	✔	✔	JSON, ФОРМА, МНОГОЧАСТНЫЙ, ТЕКСТ	Анонимно, ✔️ PHP Лига	✔	связь
Питон	✔	✔	ФОРМА, JSON, МНОГОЧАСТНЫЙ, ТЕКСТ	Аноним, Лазурный	✔	связь
Руби			ФОРМА, JSON, МНОГОЧАСТНЫЙ, ТЕКСТ	Анонимно, OAuth2
Быстрый			ФОРМА, JSON, ФОРМА, ТЕКСТ	Аноним, Лазурный
Типскрипт/JavaScript			ФОРМА, JSON, МНОГОЧАСТНЫЙ, ТЕКСТ	Анонимно, ключ API, Azure, SPFx		связь

Обозначения: ✔ -> стабильно, -> в предварительной версии, -> не запущено, ▶ -> в процессе.

Справочник параметров

Параметры документированы здесь.

Отладка

Сначала убедитесь, что вы установили необходимые компоненты. Если вы используете Visual Studio Code в качестве IDE, файл launch.json уже содержит конфигурацию для запуска Kiota. По умолчанию эта конфигурация будет использовать openApiDocs/v1.0/Mail.yml в репозитории PowerShell в качестве OpenAPI для создания SDK. По умолчанию эта конфигурация выводит сгенерированные файлы в папкуgraphdotnetv4|graphjavav4|graphtypescriptv4, расположенную в родительской папке, в которой клонирован этот репозиторий.

Выбор языка, для которого вы хотите создать клиент API, на вкладке «Отладка Visual Studio» и нажатие F5 автоматически создаст, запустит и прикрепит процесс отладки к Kiota.

Образцы

Вы можете найти примеры клиентов, созданных с помощью Kiota, в репозитории образцов Kiota.

Пример приложения, вызывающего несколько API, можно найти в репозитории KiotaApp.

Содействие

Этот проект приветствует вклад и предложения. Большинство вкладов требует от вас согласия с Лицензионным соглашением для авторов (CLA), в котором говорится, что вы имеете право и действительно предоставляете нам права на использование вашего вклада. Подробную информацию можно найти на странице https://cla.opensource.microsoft.com.

Когда вы отправляете запрос на включение, бот CLA автоматически определяет, нужно ли вам предоставить CLA, и соответствующим образом оформляет PR (например, проверку статуса, комментарий). Просто следуйте инструкциям бота. Вам нужно будет сделать это только один раз во всех репозиториях, используя наш CLA.

В этом проекте принят Кодекс поведения Microsoft с открытым исходным кодом. Для получения дополнительной информации см. Часто задаваемые вопросы о Кодексе поведения или свяжитесь с нами по адресу [email protected], если у вас возникнут дополнительные вопросы или комментарии.

Товарные знаки

Этот проект может содержать товарные знаки или логотипы проектов, продуктов или услуг. Разрешенное использование товарных знаков и логотипов Microsoft регулируется и должно соответствовать Руководству Microsoft по товарным знакам и брендам. Использование товарных знаков или логотипов Microsoft в измененных версиях этого проекта не должно вызывать путаницу или подразумевать спонсорство Microsoft. Любое использование товарных знаков или логотипов третьих лиц регулируется политикой этих третьих сторон.