You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/build-register-apis-vscode-extension.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,8 @@ ms.custom:
16
16
API developers in your organization can build and register APIs in your [API center](overview.md) inventory by using the Azure API Center extension for Visual Studio Code. API developers can:
17
17
18
18
* Add an existing API to an API center as a one-time operation, or integrate a development pipeline to register APIs as part of a CI/CD workflow.
19
-
* Generate new OpenAPI specs from API code using GitHub Copilot, or from natural language prompts using GitHub Copilot for Azure. Then, register new APIs to an API center.
19
+
* Use GitHub Copilot to generate new OpenAPI specs from API code.
20
+
* Use natural language prompts with the API Center plugin for GitHub Copilot for Azure to create new OpenAPI specs.
20
21
21
22
API developers can also take advantage of features in the extension to [discover and consume APIs](discover-apis-vscode-extension.md) in the API center and ensure [API governance](govern-apis-vscode-extension.md).
22
23
@@ -27,7 +28,7 @@ The following Visual Studio Code extensions are needed for the specified scenari
27
28
*[GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions) - to register APIs using a CI/CD pipeline with GitHub Actions
28
29
*[Azure Pipelines](https://marketplace.visualstudio.com/items?itemName=ms-azure-devops.azure-pipelines) - to register APIs using a CI/CD pipeline with Azure Pipelines
29
30
*[GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) - to generate OpenAPI specification files from API code
30
-
*[GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) - to generate OpenAPI specification files using natural language prompts
31
+
*[GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) - to generate OpenAPI specification files using the Azure API Center Plugin for GitHub Copilot for Azure
@@ -52,7 +53,7 @@ The following steps register an API in your API center with a CI/CD pipeline. Wi
52
53
53
54
Learn more about setting up a [GitHub Actions workflow](register-apis-github-actions.md) to register APIs with your API center.
54
55
55
-
## Generate OpenAPI specification file from API code
56
+
## Generate OpenAPI spec from API code
56
57
57
58
Use the power of GitHub Copilot with the Azure API Center extension for Visual Studio Code to create an OpenAPI specification file from your API code. Right-click on the API code, select **Copilot** from the options, and select **Generate API documentation**. GitHub Copilot creates an OpenAPI specification file.
58
59
@@ -63,9 +64,9 @@ Use the power of GitHub Copilot with the Azure API Center extension for Visual S
63
64
64
65
After generating the OpenAPI specification file and checking for accuracy, you can register the API with your API center using the **Azure API Center: Register API** command.
65
66
66
-
## Generate OpenAPI specification file using natural language prompts
67
+
## Generate OpenAPI spec using natural language prompts
67
68
68
-
GitHub Copilot for Azure combined with the Azure API Center extension for Visual Studio Code helps you design new APIs starting from natural language prompts. With AI assistance, quickly generate an OpenAPI specification file that you describe and complies with your organization's API governance standards.
69
+
The API Center plugin for GitHub Copilot for Azure helps you design new APIs starting from natural language prompts. With AI assistance, quickly generate an OpenAPI spec that for API development and comply with your organization's governance standards.
69
70
70
71
> [!NOTE]
71
72
> This feature is available in the pre-release version of the API Center extension.
@@ -76,7 +77,7 @@ GitHub Copilot for Azure combined with the Azure API Center extension for Visual
76
77
1. In the chat panel, make a request in natural language to the `@azure` agent to describe what the API does. Example:
77
78
78
79
```vscode
79
-
@azure Generate OpenAPI spec: 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.
80
+
@azure Generate OpenAPI spec: 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.
80
81
```
81
82
82
83
The agent responds with an OpenAPI specification document.
0 commit comments