Skip to content

design-api-github-copilot-azure.md

Latest commit

 

History

History
81 lines (49 loc) · 5.41 KB

design-api-github-copilot-azure.md

File metadata and controls

81 lines (49 loc) · 5.41 KB
title Develop APIs with GitHub Copilot for Azure - API Center plugin
description With AI assistance, API developers can use the Azure API Center plugin for GitHub Copilot for Azure to design and develop compliant APIs.
ms.service azure-api-center
ms.topic how-to
ms.date 09/26/2025
ms.update-cycle 180-days
ms.collection ce-skilling-ai-copilot
ms.custom

Design and develop APIs using API Center plugin for GitHub Copilot for Azure

The API Center plugin for GitHub Copilot for Azure accelerates design and development of new APIs starting from natural language prompts. With AI assistance available through the API Center plugin combined with the API Center VS Code extension, simply describe your API and quickly generate an OpenAPI spec for API development that complies with your organization's standards. After you generate a compliant spec, you can register the API with your API center.

[!INCLUDE vscode-extension-basic-prerequisites]

[!INCLUDE vscode-extension-setup]

Make request to the @azure agent

Follow these steps to generate an OpenAPI specification using natural language prompts with GitHub Copilot for Azure:

  1. If desired, set an active API style guide in the Azure API Center extension. Use the Ctrl+Shift+P keyboard shortcut to open the Command Palette. Type Azure API Center: Set API Style Guide, make a selection, and hit Enter.

    If no style guide is set, the default spectral:oas ruleset is used. Learn more about API specification linting using the API Center extension.

  2. In the chat panel, make a request in natural language to the @azure agent to describe what the API does. Example:

    @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 is powered by AI, so surprises and mistakes are possible. For more information, see Copilot FAQs.

    The agent responds with an OpenAPI specification document.

    :::image type="content" source="media/design-api-github-copilot-azure/generate-api-specification.png" alt-text="Screenshot showing how to use @azure extension to generate an OpenAPI spec from a prompt.":::

  3. Review the generated output for accuracy, completeness, and compliance with your API style guide.

    Refine the prompt if needed to regenerate the spec, or repeat the process using a different style guide that you set in the Azure API Center extension.

    [!TIP] Effective prompts focus on an API's business requirements rather than implementation details. Shorter prompts sometimes work better than longer ones.

  4. When it meets your requirements, save the generated OpenAPI specification to a file.

Register the API in your API center

Use the Azure API Center extension for VS Code to register the API in your API center from the generated specification file. After registering the API, you can use the extension to view the API documentation, generate an HTTP client, perform further linting and analysis, and more.

  1. In VS Code, select Register your API in API Center button in the chat panel, or select Azure API Center: Register API from the Command Palette.

  2. Select Manual.

  3. Select the API center to register APIs with.

  4. Answer prompts with information including API title, type, version title, version lifecycle, definition title, specification name, and definition (specification) file to complete API registration.

After the API is registered, you can perform various tasks using the extension. For example, view API documentation in the Swagger UI:

  1. Expand the API Center tree view to select the definition for the API version that you registered.

  2. Right-click on the definition, and select Open API Documentation. A new tab appears with the Swagger UI for the API definition.

:::image type="content" source="media/design-api-github-copilot-azure/view-definition-swagger-ui.png" alt-text="Screenshot of the Swagger UI in the VS Code extension.":::

Related content