Kiota es una herramienta de línea de comandos para generar un cliente API para llamar a cualquier API descrita por OpenAPI que le interese. El objetivo es eliminar la necesidad de depender de un SDK de API diferente para cada API que necesite llamar. Los clientes API de Kiota brindan una experiencia fuertemente tipada con todas las características que espera de un SDK de API de alta calidad, pero sin tener que aprender una nueva biblioteca para cada API HTTP.
Esta biblioteca se basa en la biblioteca Microsoft.OpenAPI.NET para garantizar una compatibilidad integral con las API que utilizan descripciones de OpenAPI. Uno de los objetivos del proyecto es proporcionar el mejor soporte posible para el generador de código para las funciones de OpenAPI y JSON Schema. La documentación conceptual describe cómo funciona Kiota y los conceptos de alto nivel. Este archivo Léame documenta cómo comenzar con Kiota.
La siguiente tabla proporciona una descripción general de los lenguajes admitidos por Kiota y el progreso en la implementación de los diferentes componentes.
Idioma | Generación | abstracciones | Publicación por entregas | Autenticación | HTTP | Herramientas y dependencias necesarias |
---|---|---|---|---|---|---|
CLI | (ver CSharp) + | (ver CSharp) | (ver CSharp) | (ver CSharp) | enlace | |
CSharp | ✔ | ✔ | FORMATO, JSON, MULTIPARTE, TEXTO | Anónimo, clave API, Azure | ✔ | enlace |
Dardo | ▶ | FORMATO, ▶ JSON, ▶ MULTIPARTE, TEXTO | Anónimo, clave API | |||
Ir | ✔ | ✔ | FORMATO, JSON, MULTIPARTE, TEXTO | Anónimo, clave API, Azure | ✔ | enlace |
Java | ✔ | ✔ | FORMATO, JSON, MULTIPARTE, TEXTO | Anónimo, clave API, Azure | ✔ | enlace |
PHP | ✔ | ✔ | JSON, FORMULARIO, MULTIPARTE, TEXTO | Anónimo, ✔️ Liga PHP | ✔ | enlace |
Pitón | ✔ | ✔ | FORMATO, JSON, MULTIPARTE, TEXTO | Anónimo, azur | ✔ | enlace |
Rubí | FORMATO, JSON, MULTIPARTE, TEXTO | Anónimo, OAuth2 | ||||
Rápido | FORMATO, JSON, FORMATO, TEXTO | Anónimo, azur | ||||
Mecanografiado/JavaScript | FORMATO, JSON, MULTIPARTE, TEXTO | Anónimo, clave API, Azure, SPFx | enlace |
Leyenda: ✔ -> estable, -> en vista previa, -> no iniciado, ▶ -> en progreso.
Los parámetros están documentados aquí.
Asegúrese de instalar los requisitos previos primero. Si está utilizando Visual Studio Code como su IDE, el archivo launch.json ya contiene la configuración para ejecutar Kiota. De forma predeterminada, esta configuración utilizará openApiDocs/v1.0/Mail.yml
en el repositorio de PowerShell como OpenAPI para generar un SDK. De forma predeterminada, esta configuración generará los archivos generados en una carpeta graphdotnetv4|graphjavav4|graphtypescriptv4 ubicada en la carpeta principal en la que se clona este repositorio.
Al seleccionar el idioma para el que desea generar un cliente API en la pestaña Depuración de Visual Studio y presionar F5 , se creará, iniciará y adjuntará automáticamente el proceso de depuración a Kiota.
Puede encontrar ejemplos de clientes generados con Kiota en el repositorio de ejemplos de Kiota.
Se puede encontrar un ejemplo de una aplicación que llama a varias API en el repositorio de KiotaApp.
Este proyecto agradece contribuciones y sugerencias. La mayoría de las contribuciones requieren que usted acepte un Acuerdo de licencia de colaborador (CLA) que declara que tiene derecho a otorgarnos, y de hecho lo hace, los derechos para usar su contribución. Para obtener más detalles, visite https://cla.opensource.microsoft.com.
Cuando envía una solicitud de extracción, un bot CLA determinará automáticamente si necesita proporcionar un CLA y decorar el PR de manera adecuada (por ejemplo, verificación de estado, comentario). Simplemente siga las instrucciones proporcionadas por el bot. Solo necesitarás hacer esto una vez en todos los repositorios que utilicen nuestro CLA.
Este proyecto ha adoptado el Código de conducta de código abierto de Microsoft. Para obtener más información, consulte las preguntas frecuentes sobre el Código de conducta o comuníquese con [email protected] si tiene alguna pregunta o comentario adicional.
Este proyecto puede contener marcas comerciales o logotipos de proyectos, productos o servicios. El uso autorizado de las marcas comerciales o logotipos de Microsoft está sujeto y debe seguir las Pautas de marcas y marcas comerciales de Microsoft. El uso de marcas comerciales o logotipos de Microsoft en versiones modificadas de este proyecto no debe causar confusión ni implicar patrocinio de Microsoft. Cualquier uso de marcas comerciales o logotipos de terceros está sujeto a las políticas de dichos terceros.