Tool overview
O que é Kiota?
Kiota é o gerador de SDK da Microsoft para clientes tipados em C#, TypeScript, Python, Go, Java e mais. Esta página é a referência canónica do fluxo completo.
Porquê usar esta referência Kiota?
Valide a prontidão OpenAPI, pré-visualize SDKs, compare geradores e exporte comandos CLI — tudo no seu navegador.
Funcionalidades principais no DevUtilities
Fluxo Build My SDK de sete passos, pontuação de prontidão, explorador API e guias de problemas/soluções.
Como usar
Siga estes passos para obter resultados precisos com a ferramenta acima.
- Cole ou carregue a sua spec OpenAPI 3 JSON/YAML — ou comece com Petstore, GitHub ou metadados do Microsoft Graph.
- Revise a pontuação de prontidão OpenAPI e corrija erros bloqueantes com o painel de diagnóstico.
- Percorra o fluxo Build My SDK: Compreender → Validar → Configurar idioma e nome do cliente → Pré-visualizar estrutura SDK.
- Na Pré-visualização, use o Explorador API e as separadores multilíngue para inspecionar operações e modelos.
- Selecione apenas os endpoints que a sua aplicação precisa para reduzir o tamanho da saída.
- Configure autenticação mapeando securitySchemes para Bearer, chave API ou OAuth no passo Auth.
- Compare Kiota com OpenAPI Generator e NSwag usando estimativas de ficheiros e tempo por spec.
- Copie o comando kiota generate ou código de exemplo TypeScript/C# do passo Gerar.
- Execute a CLI Kiota localmente para emitir ficheiros no seu projeto.
- Integre o cliente com o seu fornecedor de auth, adicione testes e fixe a versão Kiota em CI.
Referência Kiota e biblioteca de problemas/soluções
Guias Kiota, comparações de geradores, autenticação, CI/CD e correcções OpenAPI. Última revisão July 2026.
Índice de guias Kiota — comece aqui
Referencia canónica del flujo Kiota completo. Secciones: Qué es Kiota, Comparación de generadores, Matriz de idiomas, Preparación OpenAPI, operationId duplicado, Referencias circulares, Nullable, Autenticación, Endpoints seleccionados, Regeneración segura, Graph, GitHub/Stripe, CI/CD, Rendimiento, Buenas prácticas, Actualizar SDK, Limitaciones, Top problemas OpenAPI. Use el flujo Build My SDK arriba mientras lee.
O que é Kiota e quando usar
Microsoft Kiota genera clientes API tipados desde OpenAPI 3.x en C#, Go, Java, TypeScript, Python, PHP, Ruby y Swift con request builders consistentes. Úselo para Graph, APIs Azure o clientes multilenguaje modernos. DevUtilities ofrece validación, vista previa, comparación de generadores y comandos CLI sin subir su spec.
Kiota vs OpenAPI Generator vs NSwag vs AutoRest
OpenAPI Generator: ecosistema amplio. NSwag: ideal para .NET/ASP.NET. AutoRest: pipelines Azure legacy. Kiota: consistencia multilenguaje y Graph. La pestaña Comparar generadores estima archivos y tiempo para su spec.
Matriz de suporte de idiomas
Kiota 1.x soporta ocho familias de lenguaje con patrones similares. Use la vista previa multilenguaje antes de generar; los nombres reservados se escapan automáticamente.
Lista de prontidão OpenAPI para Kiota
Requiere OpenAPI 3.0/3.1 con paths, operationId únicos, esquemas de respuesta tipados y securitySchemes. La puntuación de preparación marca duplicados, refs circulares y nullable inconsistente.
Correção: operationId duplicado
Kiota usa operationId para nombres de método. Diagnóstico: busque duplicados. Corrección: asigne IDs únicos globalmente o recorte la spec. Aplique reglas Spectral en CI.
Correção: erro de referência circular
Los ciclos $ref en schemas abortan la generación. Extraiga sub-esquemas, use DTOs poco profundos o discriminadores oneOf en lugar de bucles sin límite.
Correção: problemas de schema nullable
Mezclar nullable: true (3.0) y type unions (3.1) produce modelos inconsistentes. Estandarice nulabilidad antes de regenerar.
Padrões de autenticação com Kiota
Kiota no embebe secretos: use proveedores Bearer, clave API u OAuth en el adaptador. Graph usa Azure.Identity. El paso Auth mapea securitySchemes a código inicial.
Gerar apenas endpoints selecionados
Use --include-path/--exclude-path con globs. El selector de endpoints aquí ajusta estimaciones y exporta flags en el comando generate.
Regenerar SDK sem perder alterações personalizadas
Trate el código generado como artefacto de compilación. Genere en ./generated, no edite allí, use fachadas propias y kiota-lock.json en git.
Exemplo completo: Microsoft Graph
Descargue metadatos Graph, recorte paths, kiota generate -l typescript, autentique con DefaultAzureCredential y llame client.me.get(). Maneje 401/429 con políticas de reintento.
Exemplos reais: GitHub REST e Stripe
GitHub: spec grande — recorte repos/pulls, PAT Bearer. Stripe: verifique discriminadores en objetos polimórficos. Petstore: smoke test pequeño para comparar tiempos.
Integração CI/CD
Fije versión CLI, lint Spectral, kiota generate, falle PR si git diff no vacío. OpenAPI es fuente de verdad.
Desempenho com specs OpenAPI grandes
Graph-scale puede producir miles de archivos — recorte agresivamente. DevUtilities estima segundos y recuento de archivos antes de ejecutar localmente.
Boas práticas para specs grandes
Divida por contexto acotado, use tags consistentes, operationId temprano, versionado /v1 /v2, elimine paths x-internal antes de generate.
Atualizar SDK existente após mudanças na API
Actualice spec, diff, regenere, revise git diff. Trate operationId como contrato público. Comunique cambios vía changelog del diff.
Limitações e alternativas
Kiota solo genera clientes. oneOf complejos, callbacks y webhooks pueden simplificarse. Use fetch crudo para casos extremos.
Principais problemas OpenAPI que quebram a geração de SDK
Top 10: operationId duplicado/faltante, $ref circular, respuesta 200 vacía, nullable mixto, additionalProperties laxo, parámetros keyword, sin servers, schemas inline repetidos, security no aplicado, enums inconsistentes.
Perguntas frequentes
Respostas para problemas comuns e questões de privacidade de dados.
Ferramentas relacionadas
Explore outros utilitários relacionados que complementam esta ferramenta.
Documentação oficial e referências
Especificações e documentação da plataforma para esta utilidade.