kiota

Projeto

Kiota é uma ferramenta de linha de comando para gerar um cliente API para chamar qualquer API descrita em OpenAPI na qual você esteja interessado. O objetivo é eliminar a necessidade de depender de um SDK de API diferente para cada API que você precisa chamar. Os clientes da API Kiota fornecem uma experiência fortemente tipada com todos os recursos que você espera de um API SDK de alta qualidade, mas sem precisar aprender uma nova biblioteca para cada API HTTP.

Esta biblioteca se baseia na biblioteca Microsoft.OpenAPI.NET para garantir suporte abrangente para APIs que usam descrições OpenAPI. Um dos objetivos do projeto é fornecer o melhor suporte possível ao gerador de código para recursos OpenAPI e JSON Schema. A documentação conceitual descreve como o Kiota funciona e os conceitos de alto nível. Este leia-me documenta como começar a usar o Kiota.

Começando

Gerando SDKs

1. Instale as ferramentas e dependências necessárias. (consulte a tabela Idiomas suportados na coluna Ferramentas e dependências necessárias )
2. Obtenha o Kiota usando uma das opções disponíveis.
3. Gere seu cliente API, verifique a referência de parâmetros para as diferentes opções.
4. Comece a chamar sua API usando seu API Client fluente.

Idiomas suportados

A tabela a seguir fornece uma visão geral das linguagens suportadas pelo Kiota e o progresso na implementação dos diferentes componentes.

Linguagem	Geração	Abstrações	Serialização	Autenticação	HTTP	Ferramentas e dependências necessárias
CLI		(veja CSharp) +	(veja CSharp)	(veja CSharp)	(veja CSharp)	link
CSharp	✔	✔	FORMULÁRIO, JSON, MULTIPART, TEXTO	Anônimo, chave de API, Azure	✔	link
Dardo	▶		FORMULÁRIO, ▶ JSON, ▶ MULTIPART, TEXTO	Anônimo, chave de API
Ir	✔	✔	FORMULÁRIO, JSON, MULTIPART, TEXTO	Anônimo, chave de API, Azure	✔	link
Java	✔	✔	FORMULÁRIO, JSON, MULTIPART, TEXTO	Anônimo, chave de API, Azure	✔	link
PHP	✔	✔	JSON, FORMULÁRIO, MULTIPART, TEXTO	Anônimo, ✔️ Liga PHP	✔	link
Pitão	✔	✔	FORMULÁRIO, JSON, MULTIPART, TEXTO	Anônimo, Azure	✔	link
Rubi			FORMULÁRIO, JSON, MULTIPART, TEXTO	Anônimo, OAuth2
Rápido			FORMULÁRIO, JSON, FORMULÁRIO, TEXTO	Anônimo, Azure
TypeScript/JavaScript			FORMULÁRIO, JSON, MULTIPART, TEXTO	Anônimo, chave API, Azure, SPFx		link

Legenda: ✔ -> estável, -> em pré-visualização, -> não iniciado, ▶ -> em andamento.

Referência de parâmetros

Os parâmetros estão documentados aqui.

Depuração

Certifique-se de instalar os pré-requisitos primeiro. Se você estiver usando o Visual Studio Code como seu IDE, o arquivo launch.json já contém a configuração para executar o Kiota. Por padrão, esta configuração usará openApiDocs/v1.0/Mail.yml no repositório do PowerShell como o OpenAPI para gerar um SDK. Por padrão, esta configuração produzirá os arquivos gerados em uma pasta graphdotnetv4|graphjavav4|graphtypescriptv4 localizada na pasta pai na qual este repositório foi clonado.

Selecionar o idioma para o qual deseja gerar um cliente API na guia Visual Studio Debug e pressionar F5 criará, iniciará e anexará automaticamente o processo de depuração ao Kiota.

Amostras

Você pode encontrar amostras de clientes gerados com o Kiota no repositório de amostras do Kiota.

Um exemplo de aplicativo que está chamando várias APIs pode ser encontrado no repositório KiotaApp

Contribuindo

Este projeto aceita contribuições e sugestões. A maioria das contribuições exige que você concorde com um Contrato de Licença de Colaborador (CLA), declarando que você tem o direito de nos conceder, e realmente nos concede, os direitos de uso de sua contribuição. Para obter detalhes, visite https://cla.opensource.microsoft.com.

Quando você envia uma solicitação pull, um bot CLA determinará automaticamente se você precisa fornecer um CLA e decorará o PR adequadamente (por exemplo, verificação de status, comentário). Basta seguir as instruções fornecidas pelo bot. Você só precisará fazer isso uma vez em todos os repositórios usando nosso CLA.

Este projeto adotou o Código de Conduta de Código Aberto da Microsoft. Para obter mais informações, consulte as Perguntas frequentes sobre o Código de Conduta ou entre em contato com [email protected] com perguntas ou comentários adicionais.

Marcas registradas

Este projeto pode conter marcas registradas ou logotipos de projetos, produtos ou serviços. O uso autorizado de marcas registradas ou logotipos da Microsoft está sujeito e deve seguir as Diretrizes de Marcas Registradas e Marcas da Microsoft. O uso de marcas registradas ou logotipos da Microsoft em versões modificadas deste projeto não deve causar confusão nem implicar patrocínio da Microsoft. Qualquer uso de marcas registradas ou logotipos de terceiros está sujeito às políticas desses terceiros.