Descubrimiento y registro de API con la extensión del Centro de API de Azure para Visual Studio Code
Los desarrolladores de API de su organización pueden detectar y consumir API en el Centro de API mediante la extensión del Centro de API de Azure para Visual Studio Code. La extensión proporciona las siguientes características:
Descubra las API: explore las API de su centro de API y consulte sus detalles y documentación.
Consumir las API: genera API clientes de SDK para su lenguaje favorito, incluidos JavaScript, TypeScript, .NET, Python y Java, utilizando el motor Microsoft Kiota que genera SDK para Microsoft Graph, GitHub y más.
Los desarrolladores de API también pueden aprovechar las características de la extensión para registrar las API en el Centro de API y garantizar la gobernanza de API.
Sugerencia
Si lo desea, puede habilitar un catálogo de API de plataforma para el Centro de API en Visual Studio Code para que los desarrolladores de aplicaciones de su organización puedan detectar API en una ubicación centralizada. El catálogo de API de plataforma es una vista de solo lectura del inventario de API.
Requisitos previos
Uno o más centros de API en su suscripción Azure.
- Actualmente, debe tener asignado el rol Colaborador del servicio del Centro de API de Azure o permisos superiores en un centro de API para administrar las API con la extensión.
- Extensión de cliente REST: para enviar peticiones HTTP y ver las respuestas en Visual Studio Code directamente
- Extensión Microsoft Kiota: para generar clientes API
Configuración
Instale la extensión Azure API Center para Visual Studio Code desde Visual Studio Code Marketplace. Instale otras extensiones según sea necesario.
Nota:
Cuando se indica, algunas características solo están disponibles en la versión preliminar de la extensión del Centro de API de Azure. Al instalar la extensión desde el Marketplace de Visual Studio Code, puede optar por instalar la versión de lanzamiento o una versión preliminar. Cambie entre las dos versiones en cualquier momento mediante el menú contextual del botón Administrar de la extensión en la vista Extensiones.
En Visual Studio Code, en la barra de actividades de la izquierda, seleccione Centro de API.
Si no ha iniciado sesión en su cuenta Azure, seleccione Iniciar sesión en Azure... y siga las instrucciones para iniciar sesión. Seleccione una suscripción de Azure con el Centro de API (o centros de API) desde el que quiera ver las API. También puede filtrar por suscripciones específicas si tiene muchas para ver.
Detección de API
Los recursos de su Centro de API aparecen en la vista de árbol de la izquierda. Amplíe un recurso del centro de API para ver las API, las versiones, las definiciones, los entornos y las implementaciones.
Busque API dentro de un centro de API mediante el icono de búsqueda que se muestra en el elemento de vista árbol de Apis.
Ver la documentación de la API
Puede consultar la documentación de una definición de API en su centro de API y probar las operaciones de la API. Esta función solo está disponible para las API basadas en OpenAPI en su centro de API.
Expanda la vista de árbol del centro de API para mostrar una definición de API.
Haga clic con el botón derecho del ratón en la definición y seleccione Abrir documentación de la API. Aparece una nueva pestaña con la interfaz Swagger para la definición de la API.
Para probar la API, seleccione un punto de conexión, seleccione Probar, introduzca los parámetros necesarios y seleccione Ejecutar.
Nota:
Dependiendo de la API, es posible que tenga que proporcionar credenciales de autorización o una clave de API para probar la API.
Sugerencia
Con la versión preliminar de la extensión, puede generar documentación de API en Markdown, un formato fácil de mantener y compartir con los usuarios finales. Haga clic con el botón derecho en la definición y seleccione Generar Markdown.
Generación de un archivo HTTP
Puede ver un archivo .http basado en la definición de API en su centro de API. Si la extensión REST Client está instalada, puede realizar peticiones de directorio desde el editor de código de Visual Studio. Esta función solo está disponible para las API basadas en OpenAPI en su centro de API.
Expanda la vista de árbol del centro de API para mostrar una definición de API.
Haga clic con el botón derecho en la definición y seleccione Generar archivo HTTP. Aparece una nueva pestaña que muestra un documento .http con la especificación de la API.
Para realizar una solicitud, seleccione un punto de conexión y elija Enviar solicitud.
Nota:
Dependiendo de la API, es posible que tenga que proporcionar credenciales de autorización o una clave de API para realizar la solicitud.
Generar cliente API
Utilice la extensión Microsoft Kiota para generar un cliente API para su idioma favorito. Esta función solo está disponible para las API basadas en OpenAPI en su centro de API.
- Expanda la vista de árbol del centro de API para mostrar una definición de API.
- Haga clic con el botón derecho en la definición y seleccione Generar cliente API. Aparecerá el panel del Generador OpenAPI de Kiota.
- Seleccione los puntos de conexión de la API y las operaciones HTTP que desea incluir en sus SDK.
- Seleccione Generar cliente API.
Introduzca los detalles de configuración sobre el nombre del SDK, el espacio de nombres y el directorio de salida.
Seleccione el idioma para el SDK generado.
Se genera el cliente.
Para obtener más detalles sobre el uso de la extensión Kiota, consulte Extensión Microsoft Kiota para Visual Studio Code.
Exportación de especificación de API
Puede exportar una especificación de API desde una definición y, después, descargarla como un archivo.
Para exportar una especificación en la vista de árbol de la extensión:
Expanda la vista de árbol del centro de API para mostrar una definición de API.
Haga clic con el botón derecho en la definición y seleccione Documento de especificación de API de exportación. Aparece una nueva pestaña que representa un documento de especificaciones de la API.
Las especificaciones también se pueden exportar una especificación mediante la paleta de comandos:
- Presione la combinación de teclas Ctrl+Mayús+P para abrir la paleta de comandos.
- Seleccione Centro de API de Azure: Exportación del documento de especificación de API.
- Realice las selecciones necesarias para ir a una definición de API. Aparece una nueva pestaña que representa un documento de especificaciones de la API.