Skip to content

Commit 9d24fe1

Browse files
author
gitName
committed
rename file, cross-link
1 parent 2240d24 commit 9d24fe1

10 files changed

+25
-14
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"redirections": [
3+
{
4+
"source_path_from_root": "/articles/api-center/use-vscode-extension.md",
5+
"redirect_url": "/azure/api-center/build-register-apis-vscode-extension",
6+
"redirect_document_id": false
7+
}
8+
9+
]
10+
}

articles/api-center/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
- name: Import APIs from API Management
4040
href: import-api-management-apis.md
4141
- name: Build and register APIs - VS Code extension
42-
href: use-vscode-extension.md
42+
href: build-register-apis-vscode-extension.md
4343
- name: Register APIs - GitHub Actions
4444
href: register-apis-github-actions.md
4545
- name: API governance
@@ -57,7 +57,7 @@
5757
- name: API discovery and consumption
5858
items:
5959
- name: Enable platform API catalog - VS Code extension
60-
href: enable-data-view-vscode-extension.md
60+
href: enable-platform-api-catalog-vscode-extension.md
6161
- name: Self-host Azure API Center portal
6262
href: enable-api-center-portal.md
6363
- name: Check API calls use minimal permissions with Dev Proxy

articles/api-center/use-vscode-extension.md renamed to articles/api-center/build-register-apis-vscode-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To build, discover, explore, and consume APIs in your [API center](overview.md),
3535
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
3636

3737
> [!NOTE]
38-
> Where noted, certain features are available only in the extension's pre-release version.[!INCLUDE [vscode-extension-prerelease-features](includes/vscode-extension-prerelease-features.md)]
38+
> Where noted, certain features are available only in the extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](includes/vscode-extension-prerelease-features.md)]
3939
4040
The following Visual Studio Code extensions are optional and needed only for certain scenarios as indicated:
4141

articles/api-center/enable-platform-api-catalog-vscode-extension.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,14 @@ For detailed prerequisites and steps to assign a role to users and groups, see [
8383
> [!NOTE]
8484
> To streamline access configuration for new users, we recommend that you assign the role to a Microsoft Entra group and configure a dynamic group membership rule. To learn more, see [Create or update a dynamic group in Microsoft Entra ID](/entra/identity/users/groups-create-rule).
8585
86-
## Steps for developers to connect to an API center
86+
## Steps to access the platform API catalog in Visual Studio Code
8787

88-
Developers in the enterprise can follow these steps to connect and sign in to an API center from the Visual Studio code extension.
88+
Developers in the enterprise can follow these steps to connect and sign in to view a platform API catalog using the Visual Studio code extension.
8989

9090
1. Install the pre-release version of the [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center) for Visual Studio Code.
9191

9292
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
93+
9394
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-activity-bar.png" alt-text="Screenshot of the API Center icon in the Activity Bar.":::
9495

9596
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Connect to an API Center** and hit **Enter**.
@@ -114,9 +115,9 @@ Developers in the enterprise can follow these steps to connect and sign in to an
114115

115116
1. Repeat the preceding steps to connect to more API centers, if access is configured.
116117

117-
## Discover and consume APIs
118+
## Discover and consume APIs in the catalog
118119

119-
The Azure API Center platform API catalog helps enterprise developers discover API details and start API client development. Developers can access the following features by right-clicking on an API definition in the platform API catalog:
120+
The platform API catalog helps enterprise developers discover API details and start API client development. Developers can access the following features by right-clicking on an API definition in the platform API catalog:
120121

121122
* **Export API specification document** - Export an API specification from a definition and then download it as a file
122123
* **Generate API client** - Use the Microsoft Kiota extension to generate an API client for their favorite language
@@ -156,6 +157,6 @@ After re-registering the resource provider, try again to request API permissions
156157

157158
## Related content
158159

159-
* [Get started with the Azure API Center extension for Visual Studio Code](use-vscode-extension.md)
160+
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
160161
* [Best practices for Azure RBAC](../role-based-access-control/best-practices.md)
161162
* [Register a resource provider](../azure-resource-manager/management/resource-providers-and-types.md#register-resource-provider)

articles/api-center/manage-apis-azure-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,5 @@ To delete individual API versions and definitions, use [az apic api version dele
135135

136136
* See the [Azure CLI reference for Azure API Center](/cli/azure/apic) for a complete command list, including commands to manage [environments](/cli/azure/apic/environment), [deployments](/cli/azure/apic/api/deployment), [metadata schemas](/cli/azure/apic/metadata), and [services](/cli/azure/apic).
137137
* [Import APIs to your API center from API Management](import-api-management-apis.md)
138-
* [Use the Visual Studio extension for API Center](use-vscode-extension.md) to build and register APIs from Visual Studio Code.
138+
* [Use the Visual Studio extension for API Center](build-register-apis-vscode-extension.md) to build and register APIs from Visual Studio Code.
139139
* [Register APIs in your API center using GitHub Actions](register-apis-github-actions.md)
-23.5 KB
Loading
-17.3 KB
Loading

articles/api-center/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ With an API center, stakeholders throughout your organization - including API pr
3333

3434
Create and use an API center for the following:
3535

36-
* **API inventory management** - Register all of your organization's APIs for inclusion in a centralized inventory.
36+
* **API inventory management** - API developers and API program managers can register all of your organization's APIs for inclusion in a centralized inventory using the Azure portal, the Azure CLI, or developer tooling including the Azure API Center extension for Visual Studio Code and CI/CD pipelines.
3737

3838
* **Real-world API representation** - Add real-world information about each API including versions and definitions such as OpenAPI definitions. List API deployments and associate them with runtime environments, for example, representing Azure API Management or other API management solutions.
3939

40-
* **API governance** - Organize and filter APIs and related resources using built-in and custom metadata, to help with API governance and discovery by API consumers. Set up [linting and analysis](enable-api-analysis-linting.md) to enforce API definition quality. Integrate with tools such as Dev Proxy to ensure that apps don't use unregistered [shadow APIs](discover-shadow-apis-dev-proxy.md) or APIs that don't meet organizational standards.
40+
* **API governance** - Organize and filter APIs and related resources using built-in and custom metadata, to help with API governance and discovery by API consumers. Set up [linting and analysis](enable-managed-api-analysis-linting.md) to enforce API definition quality. API developers can shift-left API design conformance checks into Visual Studio Code with integrated linting support and breaking change detection. Integrate with tools such as Dev Proxy to ensure that apps don't use unregistered [shadow APIs](discover-shadow-apis-dev-proxy.md) or APIs that don't meet organizational standards.
4141

42-
* **API discovery and reuse** - Enable developers and API program managers to discover APIs via the Azure portal, an API Center portal, and developer tools including a [Visual Studio Code extension](use-vscode-extension.md).
42+
* **API discovery and reuse** - Enable enterprise developers and API program managers to discover APIs via an API Center portal or an [API platform catalog](enable-platform-api-catalog-vscode-extension.md) that's accessed using the Azure API Center Visual Studio Code extension.
4343

4444
For more about the entities you can manage and the capabilities in Azure API Center, see [Key concepts](key-concepts.md).
4545

articles/api-center/register-apis-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ To configure the workflow file:
138138
1. Add this workflow file in the `/.github/workflows/` path in your GitHub repository.
139139

140140
> [!TIP]
141-
> Using the [Visual Studio Code extension](use-vscode-extension.md) for Azure API Center, you can generate a starting workflow file by running an extension command. In the Command Palette, select **Azure API Center: Register APIs**. Select **CI/CD** > **GitHub**. You can then modify the file for your scenario.
141+
> Using the [Visual Studio Code extension](build-register-apis-vscode-extension.md) for Azure API Center, you can generate a starting workflow file by running an extension command. In the Command Palette, select **Azure API Center: Register APIs**. Select **CI/CD** > **GitHub**. You can then modify the file for your scenario.
142142

143143
```yml
144144
name: Register API Definition to Azure API Center

articles/api-center/register-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ In this tutorial, you learned how to use the portal to:
139139
> * Register one or more APIs
140140
> * Add an API version with an API definition
141141
142-
As you build out your API inventory, take advantage of automated tools to register APIs, such as the [Azure API Center extension for Visual Studio Code](use-vscode-extension.md) and the [Azure CLI](manage-apis-azure-cli.md).
142+
As you build out your API inventory, take advantage of automated tools to register APIs, such as the [Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md) and the [Azure CLI](manage-apis-azure-cli.md).
143143

144144
## Next steps
145145

0 commit comments

Comments
 (0)