Skip to content

Commit 160456c

Browse files
committed
article freshness pass
1 parent 59a59c7 commit 160456c

4 files changed

Lines changed: 37 additions & 30 deletions

File tree

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Govern APIs - VS Code extension
2+
title: Govern APIs - Visual Studio Code Extension
33
description: API developers can use the Azure API Center extension for Visual Studio Code to govern their organization's APIs.
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 10/16/2024
7+
ms.date: 02/19/2026
88
ms.author: danlep
99
ms.custom:
1010
- sfi-image-nochange
@@ -18,45 +18,47 @@ To maximize success of your API governance efforts, it's critical to shift-left
1818
The Azure API Center extension for Visual Studio Code includes the following governance capabilities for API developers:
1919

2020
* Evaluating API designs against API style guides as the API is developed in Visual Studio Code.
21-
* Early detection of breaking changes so that APIs remain reliable and function as expected, preserving the trust of end-users and stakeholders.
21+
* Early detection of breaking changes so APIs remain reliable and function as expected, preserving the trust of end-users and stakeholders.
2222

2323
API developers can also take advantage of features in the extension to [register APIs](build-register-apis-vscode-extension.md) in the API center and [discover and consume APIs](discover-apis-vscode-extension.md).
2424

2525
[!INCLUDE [vscode-extension-basic-prerequisites](includes/vscode-extension-basic-prerequisites.md)]
2626

27-
* [Spectral extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral) - to run shift-left API design conformance checks in Visual Studio Code
28-
* [Optic CLI](https://github.com/opticdev/optic) - to detect breaking changes between API specification documents
27+
* [Spectral extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral) to run shift-left API design conformance checks in Visual Studio Code.
28+
29+
* [Optic CLI](https://github.com/opticdev/optic) to detect breaking changes between API specification documents.
2930

3031
[!INCLUDE [vscode-extension-setup](includes/vscode-extension-setup.md)]
3132

3233
## API design conformance
3334

3435
To ensure design conformance with organizational standards as you build APIs, the Azure API Center extension for Visual Studio Code provides integrated support for API specification linting with [Spectral](https://stoplight.io/open-source/spectral).
3536

36-
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set active API Style Guide** and hit **Enter**.
37-
2. Select one of the default rules provided, or, if your organization has a style guide already available, use **Select Local File** or **Input Remote URL** to specify the active ruleset in Visual Studio Code. Hit **Enter**.
37+
1. Use the **Ctrl**+**Shift**+**P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set active API Style Guide** followed by the **Enter** key.
38+
39+
1. Select one of the default rules provided. If your organization has a style guide already available, select the **Select Local File** or **Input Remote URL** option and specify the active ruleset in Visual Studio Code. Select **Enter**.
3840

39-
Once an active API style guide is set, opening any OpenAPI or AsyncAPI-based specification file triggers a local linting operation in Visual Studio Code. Results are displayed both inline in the editor and in the Problems window (**View** > **Problems** or **Ctrl+Shift+M**).
41+
After an active API style guide is set, opening any OpenAPI or AsyncAPI-based specification file triggers a local linting operation in Visual Studio Code. Results are displayed both inline in the editor and in the **Problems** window (**View** > **Problems** or **Ctrl**+**Shift**+**M**).
4042

4143
:::image type="content" source="media/govern-apis-vscode-extension/local-linting.png" alt-text="Screenshot of local-linting in Visual Studio Code." lightbox="media/govern-apis-vscode-extension/local-linting.png":::
4244

4345
## Breaking change detection
4446

45-
When introducing new versions of your API, it's important to ensure that changes introduced do not break API consumers on previous versions of your API. The Azure API Center extension for Visual Studio Code makes this easy with breaking change detection for OpenAPI specification documents powered by [Optic](https://github.com/opticdev/optic).
47+
When introducing new versions of your API, it's important to ensure that changes introduced don't break API consumers on previous versions of your API. The Azure API Center extension for Visual Studio Code makes this task easy with breaking change detection for OpenAPI specification documents powered by [Optic](https://github.com/opticdev/optic).
4648

47-
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Detect Breaking Change** and hit **Enter**.
48-
2. Select the first API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
49-
3. Select the second API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
49+
1. Use the **Ctrl**+**Shift**+**P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Detect Breaking Change** followed by the **Enter** key.
5050

51-
Visual Studio Code opens a diff view between the two API specifications. Any breaking changes are displayed both inline in the editor and in the Problems window (**View** > **Problems** or **Ctrl+Shift+M**).
51+
1. Select the first API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
5252

53-
:::image type="content" source="media/govern-apis-vscode-extension/breaking-changes.png" alt-text="Screenshot of breaking changes detected in Visual Studio Code." lightbox="media/govern-apis-vscode-extension/breaking-changes.png":::
53+
1. Select the second API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
5454

55+
Visual Studio Code opens a diff view between the two API specifications. Any breaking changes are displayed both inline in the editor and in the **Problems** window (**View** > **Problems** or **Ctrl**+**Shift**+**M**).
56+
57+
:::image type="content" source="media/govern-apis-vscode-extension/breaking-changes.png" alt-text="Screenshot of breaking changes detected in Visual Studio Code." lightbox="media/govern-apis-vscode-extension/breaking-changes.png":::
5558

5659
## Related content
5760

5861
* [Azure API Center - key concepts](key-concepts.md)
5962
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
6063
* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
61-
* [Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
62-
64+
* [Enable and view the API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)

articles/api-center/includes/vscode-extension-basic-prerequisites.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Include file
3-
description: Include file
3+
description: Basic prerequisites for using the Azure API Center extension for Visual Studio Code.
44
services: api-center
55
author: dlepow
66

@@ -17,6 +17,6 @@ ms.custom: Include file
1717

1818
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
1919

20-
* One or more API centers in your Azure subscription. You can [create an API center using the Azure API Center extension](../set-up-api-center-vs-code-extension.md) or other tools.
20+
* One or more API centers in your Azure subscription. You can [create an API center by using the Azure API Center extension](../set-up-api-center-vs-code-extension.md) or other tools.
2121

22-
* Currently, you need to be assigned the Azure API Center Service Contributor role or higher permissions on an API center to manage APIs with the extension.
22+
* To manage APIs with the extension, you currently need the Azure API Center Service Contributor role or higher permissions on an API center.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Include file
3-
description: Include file
3+
description: Describes how to install and select specific versions of the Azure API Center extension in Visual Studio Code.
44
services: api-center
55
author: dlepow
66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 09/23/2024
9+
ms.date: 02/19/2026
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
1313

14-
When installing the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a pre-release version. Switch between the two versions at any time by using the extension's **Manage** button context menu in the Extensions view.
14+
When you install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a prerelease version (as available). To switch between installed versions, select the extension's **Manage** button (gear icon) in the **Extensions** view in Visual Studio Code.
Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
11
---
22
title: Include file
3-
description: Include file
3+
description: The setup procedure for the Azure API Center extension for Visual Studio Code.
44
services: api-center
55
author: dlepow
66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 06/24/2025
9+
ms.date: 02/19/2026
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
1313

1414
## Extension setup
1515

16+
Set up the extension by following these steps:
17+
1618
1. Install the Azure API Center extension for Visual Studio Code from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center). Install other extensions as needed.
1719

18-
> [!NOTE]
19-
> Where noted, certain features are available only in the Azure API Center extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](vscode-extension-prerelease-features.md)]
20-
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
20+
> [!NOTE]
21+
> The `[PREVIEW]` notation indicates features available only in the prerelease version of the Azure API Center extension. [!INCLUDE [vscode-extension-prerelease-features](vscode-extension-prerelease-features.md)]
22+
23+
1. In Visual Studio Code, in the Activity bar, select API Center:
24+
25+
:::image type="content" source="media/vscode-extension-setup/api-center-activity-bar.png" border="false" alt-text="Screenshot of API Center extension icon in the Visual Studio Code Activity bar.":::
26+
27+
1. If you're not signed in to your Azure account, select **Sign in to Azure**, and follow the prompts to sign in.
2128

22-
:::image type="content" source="media/vscode-extension-setup/api-center-activity-bar.png" alt-text="Screenshot of API Center extension in the activity bar.":::
23-
1. If you're not signed in to your Azure account, select **Sign in to Azure...**, and follow the prompts to sign in.
24-
Select an Azure subscription with the API center (or API centers) you wish to view APIs from. You can also filter on specific subscriptions if you have many to view from.
29+
1. Select an Azure subscription with the API center (or API centers) that has the APIs you want to view. If you have multiple accounts, you can filter on specific subscriptions.

0 commit comments

Comments
 (0)