Tool overview
¿Qué es Kiota?
Kiota es el generador de SDK de Microsoft para clientes tipados en C#, TypeScript, Python, Go, Java y más. Esta página es la referencia canónica para entender Kiota, corregir problemas de especificación y recorrer el flujo completo generar-integrar-solucionar problemas.
¿Por qué usar esta referencia y flujo Kiota?
Valide la preparación OpenAPI, previsualice árboles SDK, compare generadores, configure autenticación y exporte comandos CLI antes de ejecutar kiota generate localmente. Todo se ejecuta en su navegador.
Funciones clave en DevUtilities
Flujo Build My SDK de siete pasos, puntuación de preparación OpenAPI, explorador API y vista previa multilenguaje, comparación de generadores, asistente de autenticación, constructor de comandos kiota generate y guías de problemas y soluciones.
Cómo usar
Siga estos pasos para obtener resultados precisos con la herramienta de arriba.
- Pegue o cargue su spec OpenAPI 3 JSON/YAML — o empiece con Petstore, GitHub o metadatos de Microsoft Graph.
- Revise la puntuación de preparación OpenAPI y corrija errores bloqueantes con el panel de diagnóstico.
- Recorra el flujo Build My SDK: Entender → Validar → Configurar idioma y nombre de cliente → Previsualizar estructura SDK.
- En Vista previa, use Explorador API, Árbol SDK y pestañas multilenguaje para inspeccionar operaciones y modelos.
- Seleccione solo los endpoints que su aplicación necesita para reducir el tamaño de salida.
- Configure autenticación mapeando securitySchemes a Bearer, clave API u OAuth en el paso Auth.
- Compare Kiota con OpenAPI Generator y NSwag usando estimaciones de archivos y tiempo por spec.
- Copie el comando kiota generate o código de uso TypeScript/C# del paso Generar.
- Ejecute la CLI Kiota localmente (dotnet tool install Microsoft.OpenApi.Kiota) para emitir archivos.
- Integre el cliente con su proveedor de auth, añada pruebas y fije la versión Kiota en CI.
Referencia Kiota y biblioteca de problemas/soluciones
Guías sobre Kiota, comparaciones de generadores, autenticación, CI/CD, ejemplos reales y correcciones para problemas OpenAPI que bloquean la generación. Última revisión July 2026.
Índice de guías Kiota — empiece aquí
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.
¿Qué es Kiota y cuándo usarlo?
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 soporte 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 preparación 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.
Corrección: operationId duplicado en Kiota
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.
Corrección: error de referencia 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.
Corrección: problemas de esquema nullable
Mezclar nullable: true (3.0) y type unions (3.1) produce modelos inconsistentes. Estandarice nulabilidad antes de regenerar.
Patrones de autenticación con 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.
Generar solo endpoints seleccionados
Use --include-path/--exclude-path con globs. El selector de endpoints aquí ajusta estimaciones y exporta flags en el comando generate.
Regenerar SDK sin perder cambios
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.
Ejemplo 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.
Ejemplos reales: GitHub REST y Stripe
GitHub: spec grande — recorte repos/pulls, PAT Bearer. Stripe: verifique discriminadores en objetos polimórficos. Petstore: smoke test pequeño para comparar tiempos.
Integración CI/CD
Fije versión CLI, lint Spectral, kiota generate, falle PR si git diff no vacío. OpenAPI es fuente de verdad.
Rendimiento con specs OpenAPI grandes
Graph-scale puede producir miles de archivos — recorte agresivamente. DevUtilities estima segundos y recuento de archivos antes de ejecutar localmente.
Buenas prácticas para specs grandes
Divida por contexto acotado, use tags consistentes, operationId temprano, versionado /v1 /v2, elimine paths x-internal antes de generate.
Actualizar SDK existente tras cambios de API
Actualice spec, diff, regenere, revise git diff. Trate operationId como contrato público. Comunique cambios vía changelog del diff.
Limitaciones y alternativas
Kiota solo genera clientes. oneOf complejos, callbacks y webhooks pueden simplificarse. Use fetch crudo para casos extremos.
Principales problemas OpenAPI que rompen la generación
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.
Preguntas frecuentes
Respuestas sobre depuración habitual y privacidad de sus datos.
Herramientas relacionadas
Explore otras utilidades relacionadas que complementan esta herramienta.
Documentación oficial y referencias
Especificaciones y documentación de plataforma para esta utilidad.