Compartir a través de

Diseño y desarrollo de API mediante el complemento del Centro de API para GitHub Copilot para Azure

  • Artículo

El complemento del Centro de API para GitHub Copilot para Azure (versión preliminar) acelera el diseño y el desarrollo de nuevas API a partir de mensajes de lenguaje natural. Con la asistencia de IA disponible a través del complemento del Centro de API combinado con la extensión VS Code del Centro de API, simplemente describa la API y genere rápidamente una especificación de OpenAPI para el desarrollo de API que cumpla con los estándares de su organización. Después de generar una especificación compatible, puede registrar la API con el Centro de API.

Nota:

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

Requisitos previos

Configuración de la extensión

  1. Instale la extensión Azure API Center para Visual Studio Code desde Visual Studio Code Marketplace. Instale otras extensiones enumeradas en requisitos previos.

    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.

Realización de una solicitud al agente @azure

Siga estos pasos para generar una especificación de OpenAPI mediante avisos de lenguaje natural con GitHub Copilot para Azure:

  1. Si lo desea, establezca una guía de estilo de API activa en la extensión del Centro de API de Azure. 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. Obtenga más información sobre Especificación de API linting mediante la extensión del Centro de API.

  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 an 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. Check that there are no duplicate keys.

    Copilot funciona con IA, por lo que es posible que se produzcan sorpresas y errores. Para obtener más información, consulte Preguntas más frecuentes sobre Copilot.

    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 obtener precisión, integridad y cumplimiento con la guía de estilo de API.

    Mejore el mensaje si es necesario para volver a generar la especificación o repita el proceso mediante una guía de estilo diferente que establezca en la extensión del Centro de API de Azure.

    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.

Registro de la API en el centro de API

Use la extensión del Centro de API de Azure para VS Code para registrar la API en el centro de API desde el archivo de especificación generado. Después de registrar la API, puede usar la extensión para ver la documentación de la API, generar un cliente HTTP, realizar más linting y análisis, etc.

  1. En VS Code, 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.

  2. Seleccione Manual.

  3. Seleccione el centro de API con el que registrar las API.

  4. Responda a las indicaciones con información que incluye 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 definición, el nombre de especificación y el archivo de definición (especificación) para completar el registro de API.

Una vez registrada la API, puede realizar varias tareas mediante la extensión. Por ejemplo, ver la documentación de API en la interfaz de usuario de Swagger:

  1. Expanda la vista de árbol del Centro de API para seleccionar la definición de la versión de API que registró.

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

Recorte de pantalla de la interfaz de usuario de Swagger en la extensión de VS Code.

Contenido relacionado