Compartir vía

Compilación y registro de API con la extensión del Centro de API de Azure para Visual Studio Code

  • Artículo

Los desarrolladores de API de la organización pueden compilar y registrar las API en el inventario del Centro de API mediante la extensión Centro de API de Azure para Visual Studio Code. Los desarrolladores de API pueden hacer lo siguiente:

  • Agregar una API existente a un centro de API como una operación única, o bien integrar una canalización de desarrollo para registrar las API como parte de un flujo de trabajo de CI/CD.
  • Use GitHub Copilot para generar nuevas especificaciones de OpenAPI a partir del código de API.
  • Use indicaciones de lenguaje natural con el complemento del Centro de API para GitHub Copilot para Azure para crear nuevas especificaciones de OpenAPI.

Los desarrolladores de API también pueden aprovechar las características de la extensión para detectar y consumir API en el centro de API y garantizar la gobernanza de API.

Requisitos previos

Se necesitan las siguientes extensiones de Visual Studio Code para los escenarios especificados:

Configurar

  1. 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.

  2. En Visual Studio Code, en la barra de actividades de la izquierda, seleccione Centro de API.

    Recorte de pantalla de la extensión del Centro de API en la barra de actividades.

  3. 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.

Registro de una API: paso a paso

Los pasos siguientes registran una API en el Centro de API como una operación única.

  1. Utilice la combinación de teclas Ctrl+Mayús+P para abrir la paleta de comandos. Escriba Azure API Center: Registrar API y pulse Intro.
  2. Seleccione Manual.
  3. Seleccione el centro de API con el que registrar las API.
  4. Responda a las indicaciones con información que incluya el título de la API, el tipo, el título de la versión, el ciclo de vida de la versión, el título de la definición, el nombre de la especificación y el archivo de definición para completar el registro de API.

La API se agrega al inventario del Centro de API.

Registro de API: canalización de CI/CD

Los pasos siguientes registran una API en el Centro de API con una canalización de CI/CD. Con esta opción, se agrega una canalización preconfigurada de GitHub o Azure DevOps al área de trabajo activa de Visual Studio Code que se ejecuta como parte de un flujo de trabajo de CI/CD en cada confirmación en el control de código fuente. Se recomienda inventariar las API con su centro de API mediante CI/CD para garantizar que los metadatos de la API, incluidas la especificación y la versión, se mantienen actualizados en su centro de API a medida que la API sigue evolucionando con el tiempo.

  1. Utilice la combinación de teclas Ctrl+Mayús+P para abrir la paleta de comandos. Escriba Azure API Center: Registrar API y pulse Intro.
  2. Seleccione CI/CD.
  3. Seleccione GitHub o Azure DevOps, en función del mecanismo de control de código fuente que prefiera. Debe estar abierta un área de trabajo de Visual Studio Code para que la extensión del Centro API agregue una canalización a tu área de trabajo. Una vez que se agregue el archivo, complete los pasos documentados en el propio archivo de canalización de CI/CD para configurar las variables de entorno y la identidad necesarias. Al enviarla al control de código fuente, la API se registra en el Centro de API.

Obtenga más información sobre cómo configurar un flujo de trabajo de acciones de GitHub para registrar las API en el centro de API.

Generación de especificaciones de OpenAPI a partir del código de API

Use la potencia de GitHub Copilot con la extensión del Centro de API de Azure para Visual Studio Code para crear un archivo de especificación de OpenAPI a partir del código de API. Haga clic con el botón derecho en el código de API, seleccione Copilot en las opciones y seleccione Generar documentación de API. GitHub Copilot crea un archivo de especificación de OpenAPI.

Nota:

Esta característica está disponible en la versión preliminar de la extensión del Centro de API.

Animación que muestra cómo usar GitHub Copilot para generar una especificación de OpenAPI a partir del código.

Después de generar el archivo de especificación de OpenAPI y comprobar la precisión, puede registrar la API en el centro de API mediante el comando Register API del Centro de API de Azure.

Generación de especificaciones de OpenAPI mediante indicaciones de lenguaje natural

El complemento del Centro de API para GitHub Copilot para Azure (versión preliminar) le ayuda a diseñar nuevas API a partir de indicaciones de lenguaje natural. Con la asistencia de inteligencia artificial, genere rápidamente una especificación de OpenAPI para el desarrollo de API que cumpla con los estándares de su organización.

Nota:

Esta característica está disponible en la versión preliminar de la extensión del Centro de API.

  1. Si lo desea, establezca una guía de estilo de API activa. Utilice la combinación de teclas Ctrl+Mayús+P para abrir la paleta de comandos. Escriba Centro de API de Azure: Establecer guía de estilo de API, realice una selección y presione Entrar.

    Si no se establece ninguna guía de estilo, se usa el conjunto de reglas predeterminado spectral:oas.

  2. En el panel de chat, realice una solicitud en lenguaje natural al agente @azure para describir lo que hace la API. Ejemplo:

    @azure Generate OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards.

    El agente responde con un documento de especificación de OpenAPI.

    Captura de pantalla que muestra cómo usar la extensión @azure para generar una especificación de OpenAPI desde un símbolo del sistema.

  3. Revise la salida generada para determinar la precisión y el cumplimiento con la guía de estilo de API. Refine la indicación para ver si es necesario volver a generarla.

    Sugerencia

    Las indicaciones efectivas se centran en los requisitos empresariales de una API en lugar de en los detalles de implementación. Las indicaciones más cortas a veces funcionan mejor que las más largas.

  4. Cuando cumpla sus requisitos, guarde la especificación de OpenAPI generada en un archivo.

  5. Registre la API en el Centro de API. Seleccione el botón Registrar la API en el Centro de API en el panel de chat o seleccione Centro de API de Azure: Registrar API en la paleta de comandos y siga las indicaciones.

Contenido relacionado