Skip to content

Commit 6c4890b

Browse files
committed
[APIC] VSCode extension updates
1 parent 6688b08 commit 6c4890b

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed
407 KB
Loading

articles/api-center/use-vscode-extension.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
title: Use Visual Studio Code extension - Azure API Center
3-
description: Discover, try, and consume APIs from your Azure API center using the API Center extension for Visual Studio Code (preview)
3+
description: Build, discover, try, and consume APIs from your Azure API center using the API Center extension for Visual Studio Code (preview)
44
author: dlepow
55
ms.service: api-center
66
ms.topic: how-to
7-
ms.date: 01/24/2024
7+
ms.date: 03/04/2024
88
ms.author: danlep
99
ms.custom:
10-
# Customer intent: As a developer, I want to use my Visual Studio Code environment to discover, try, and consume APIs in my organization's API center.
10+
# Customer intent: As a developer, I want to use my Visual Studio Code environment to build, discover, try, and consume APIs in my organization's API center.
1111
---
1212

1313
# Get started with the Azure API Center extension for Visual Studio Code (preview)
1414

15-
To discover, try, and consume APIs in your [API center](overview.md), you can use the Azure API Center extension in your Visual Studio Code development environment:
15+
To build, discover, try, and consume APIs in your [API center](overview.md), you can use the Azure API Center extension in your Visual Studio Code development environment:
1616

17-
* **Build APIs** - Make APIs you are building discoverable to others by registering them in your API center. Shift-left API design conformance checks into Visual Studio Code with integrated linting support, powered by Spectral.
17+
* **Build APIs** - Make APIs you're building discoverable to others by registering them in your API center. Shift-left API design conformance checks into Visual Studio Code with integrated linting support, powered by Spectral.
1818

1919
* **Discover APIs** - Browse the APIs in your API center, and view their details and documentation.
2020

@@ -52,14 +52,17 @@ The following Visual Studio Code extensions are optional and needed only for cer
5252

5353
## Register APIs
5454

55-
APIs can be registered in your API center directly from Visual Studio Code, either by registering it as a one-time operation or with a CI/CD pipeline.
55+
Register an API in your API center directly from Visual Studio Code, either by registering it as a one-time operation or with a CI/CD pipeline.
5656

5757
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Register API** and hit **Enter**.
58-
2. Select how you want to register your API with your API center. **Step-by-step** is best for one-time registration of APIs. **CI/CD** adds a pre-configured 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 is 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.
59-
* For **Step-by-step**, select the API Center instance to register APIs with, and additional prompts with information including API title, type, lifecycle, version, and specification will guide you through completing API registration.
60-
* For **CI/CD**, select either **GitHub** or **Azure DevOps** depending on your preferred source control mechanism. Note: A Visual Studio Code workspace must be open for the 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 API Center.
58+
1. Select how you want to register your API with your API center:
59+
* **Step-by-step** is best for one-time registration of APIs.
60+
* **CI/CD** 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.
61+
1. Complete registration steps:
62+
* For **Step-by-step**, select the API center to register APIs with, and answer prompts with information including API title, type, lifecycle stage, version, and specification to complete API registration.
63+
* For **CI/CD**, select either **GitHub** or **Azure DevOps**, depending on your preferred source control mechanism. A Visual Studio Code workspace must be open for the 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.
6164

62-
## API Design Conformance
65+
## API design conformance
6366

6467
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.
6568

@@ -68,18 +71,14 @@ To ensure design conformance with organizational standards as you build APIs, th
6871

6972
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**).
7073

71-
![APIC-Linting](https://github.com/MicrosoftDocs/azure-docs/assets/1091304/8c286941-9487-415c-badb-1481891fb0fc)
74+
:::image type="content" source="media/use-vscode-extension/local-linting.png" alt-text="Screenshot of local-linting in Visual Studio Code." lightbox="media/use-vscode-extension/local-linting.png":::
7275

7376
## Discover APIs
7477

7578
Your API center resources appear in the tree view on the left-hand side. Expand an API center resource to see APIs, versions, definitions, environments, and deployments.
7679

7780
:::image type="content" source="media/use-vscode-extension/explore-api-centers.png" alt-text="Screenshot of API Center tree view in Visual Studio Code." lightbox="media/use-vscode-extension/explore-api-centers.png":::
7881

79-
> [!NOTE]
80-
> Currently, all APIs and other entities shown in the tree view are read-only. You can't create, update, or delete entities in an API center from the extension.
81-
82-
8382
## View API documentation
8483

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

0 commit comments

Comments
 (0)