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
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,8 @@ API developers in your organization can build and register APIs in your [API cen
21
21
22
22
The following Visual Studio Code extensions is optional and needed only for the specified scenario:
23
23
24
+
25
+
*[GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) - to register APIs using a CI/CD pipeline with GitHub Actions
24
26
*[GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) - to generate OpenAPI specification files from API code
@@ -38,11 +40,10 @@ The API is added to your API center inventory.
38
40
39
41
## Register APIs - CI/CD pipeline
40
42
41
-
The following steps register an API in your API center with a CI/CD pipeline. It's recommended to inventory APIs with your API center using CI/CD to ensure API metadata including specification and version stay current in your API center as the API continues to evolve over time.
43
+
The following steps register an API in your API center with a CI/CD pipeline. With this option, add a preconfigured GitHub or Azure DevOps pipeline to your active Visual Studio Code workspace that is run as part of a CI/CD workflow on each commit to source control. It's recommended to inventory APIs with your API center using CI/CD to ensure API metadata including specification and version stay current in your API center as the API continues to evolve over time.
42
44
43
45
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Register API** and hit **Enter**.
44
46
1. Select **CI/CD**.
45
-
1. adds a preconfigured GitHub or Azure DevOps pipeline to your active Visual Studio Code workspace that is run as part of a CI/CD workflow on each commit to source control. It's recommended to inventory APIs with your API center using CI/CD to ensure API metadata including specification and version stay current in your API center as the API continues to evolve over time.
46
47
1. Select either **GitHub** or **Azure DevOps**, depending on your preferred source control mechanism. A Visual Studio Code workspace must be open for the Azure API Center extension to add a pipeline to your workspace. After the file is added, complete steps documented in the CI/CD pipeline file itself to configure Azure Pipeline/GitHub Action environment variables and identity. On push to source control, the API will be registered in your API center.
47
48
48
49
Learn more about setting up a [GitHub Actions workflow](register-apis-github-actions.md) to register APIs with your API center.
Copy file name to clipboardExpand all lines: articles/api-center/discover-apis-vscode-extension.md
+2-9Lines changed: 2 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,17 +18,13 @@ API developers in your organization can discover and consume APIs in your [API c
18
18
19
19
***Consume APIs** - Generate API SDK clients in their favorite language including JavaScript, TypeScript, .NET, Python, and Java, using the Microsoft Kiota engine that generates SDKs for Microsoft Graph, GitHub, and more.
20
20
21
-
21
+
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 ensure [API governance](govern-apis-vscode-extension.md).
22
22
23
23
> [!TIP]
24
-
> Optionally enable a [platform API catalog](enable-platform-api-catalog-vscode-extension.md) for your API center in Visual Studio Code so that app developers in your organization can discover APIs in a centralized location. The platform API catalog is a read-only view of the API inventory.
25
-
26
-
## Prerequisites
24
+
> If you want enterprise app developers to discover APIs in a centralized location, optionally enable a [platform API catalog](enable-platform-api-catalog-vscode-extension.md) for your API center in Visual Studio Code. The platform API catalog is a read-only view of the API inventory.
The following Visual Studio Code extensions are optional and needed only for certain scenarios as indicated:
31
-
32
28
*[REST client extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) - to send HTTP requests and view the responses in Visual Studio Code directly
33
29
*[Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
34
30
@@ -42,9 +38,6 @@ API center resources appear in the tree view on the left-hand side. Expand an AP
42
38
43
39
Search for APIs within an API Center by using the search icon shown in the **Apis** tree view item.
44
40
45
-
> [!TIP]
46
-
> Optionally enable a [platform API catalog](enable-platform-api-catalog-vscode-extension.md) for your API center in Visual Studio Code so that app developers in your organization can discover APIs in a centralized location. The platform API catalog is a read-only view of the API inventory.
47
-
48
41
## View API documentation
49
42
50
43
You can view the documentation for an API definition in your API center and try API operations. This feature is only available for OpenAPI-based APIs in your API center.
Copy file name to clipboardExpand all lines: articles/api-center/govern-apis-vscode-extension.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,21 +7,21 @@ ms.topic: how-to
7
7
ms.date: 09/23/2024
8
8
ms.author: danlep
9
9
ms.custom:
10
-
# Customer intent: As an API developer, I want to use my Visual Studio Code environment to govern APIs in my organization's API center.
10
+
# Customer intent: As an API developer, I want to use my Visual Studio Code environment to check API compliance in my organization's API center.
11
11
---
12
12
13
13
# Govern APIs with the Azure API Center extension for Visual Studio Code
14
14
15
-
To maximize success of your API governance efforts, it's critical to shift-left governance early into the API development cycle. This approach allows developers to create APIs correctly from the beginning, saving them from wasted development effort mitigating non-compliant APIs later in the development process. API Center's Visual Studio Code experience includes critical capabilities for API developers including:
15
+
To maximize success of your API governance efforts, it's critical to shift-left governance early into the API development cycle. This approach allows developers to create APIs correctly from the beginning, saving them from wasted development effort and mitigating non-compliant APIs later in the development process.
16
+
17
+
The Azure API Center extension for Visual Studio Code includes the following governance capabilities for API developers:
16
18
17
19
* Evaluating API designs against API style guides as the API is developed in Visual Studio Code.
18
-
* Early detection of breaking changes ensures that APIs remain reliable and function as expected, preserving the trust of end-users and stakeholders.
20
+
* Early detection of breaking changes so that APIs remain reliable and function as expected, preserving the trust of end-users and stakeholders.
The following Visual Studio Code extensions are optional and needed only for certain scenarios as indicated:
23
-
24
-
*[Spectral extension](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral) - to run shift-left API design conformance checks in Visual Studio Code
24
+
*[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
25
25
*[Optic CLI](https://github.com/opticdev/optic) - to detect breaking changes between API specification documents
@@ -35,7 +35,7 @@ To ensure design conformance with organizational standards as you build APIs, th
35
35
36
36
Once an active API style guide is set, opening any OpenAPI or AsyncAPI-based specification file will trigger a local linting operation in Visual Studio Code. Results are displayed both inline in the editor, as well as in the Problems window (**View** > **Problems** or **Ctrl+Shift+M**).
37
37
38
-
:::image type="content" source="media/build-register-apis-vscode-extension/local-linting.png" alt-text="Screenshot of local-linting in Visual Studio Code." lightbox="media/build-register-apis-vscode-extension/local-linting.png":::
38
+
:::image type="content" source="media/govern-apis-vscode-extension/local-linting.png" alt-text="Screenshot of local-linting in Visual Studio Code." lightbox="media/build-register-apis-vscode-extension/local-linting.png":::
39
39
40
40
## Breaking change detection
41
41
@@ -47,7 +47,7 @@ When introducing new versions of your API, it's important to ensure that changes
47
47
48
48
Visual Studio Code will open a diff view between the two API specifications. Any breaking changes are displayed both inline in the editor, as well as in the Problems window (**View** > **Problems** or **Ctrl+Shift+M**).
49
49
50
-
:::image type="content" source="media/build-register-apis-vscode-extension/breaking-changes.png" alt-text="Screenshot of breaking changes detected in Visual Studio Code." lightbox="media/build-register-apis-vscode-extension/breaking-changes.png":::
50
+
:::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/build-register-apis-vscode-extension/breaking-changes.png":::
Copy file name to clipboardExpand all lines: articles/api-center/includes/vscode-extension-setup.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,11 @@ ms.custom: Include file
13
13
14
14
## Setup
15
15
16
-
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 optional extensions as needed.
16
+
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.
17
17
18
18
> [!NOTE]
19
19
> Where noted, certain features are available only in the extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](vscode-extension-prerelease-features.md)]
20
20
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
21
+
:::image type="content" source="media/vscode-extension-setup/api-center-activity-bar.png" alt-text="Screenshot of API Center extension in the activity bar.":::
21
22
1. If you're not signed in to your Azure account, select **Sign in to Azure...**, and follow the prompts to sign in.
22
23
Select an Azure account 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.
0 commit comments