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/frequently-asked-questions.yml
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ metadata:
6
6
ms.author: danlep
7
7
ms.service: azure-api-center
8
8
ms.topic: faq
9
-
ms.date: 04/15/2024
9
+
ms.date: 11/15/2024
10
10
11
11
title: "Frequently asked questions - Azure API Center"
12
12
summary: |
@@ -21,21 +21,23 @@ sections:
21
21
22
22
API Management is a runtime API governance and observability solution that enables you to expose APIs securely at scale, monitor their health, and analyze their usage. [Learn more](../api-management/api-management-key-concepts.md)
23
23
24
-
API Center is a design-time API governance and centralized API discovery solution. It acts as a repository and governance tool for all APIs within an organization, regardless of where they are in their lifecycle or where they are deployed. Use an API center to collect and maintain your organization's API inventory with rich metadata, and assess and help enforce API design consistency and quality.
24
+
API Center is a design-time API governance and centralized API discovery solution. It acts as a repository and governance tool for all APIs within an organization, regardless of where they are in their lifecycle or where they're deployed. Use an API center to collect and maintain your organization's API inventory with rich metadata, and assess and help enforce API design consistency and quality.
25
25
26
26
Read more in [The Rising Significance of APIs - Azure API Management & API Center](https://techcommunity.microsoft.com/t5/azure-integration-services-blog/the-rising-significance-of-apis-azure-api-management-amp-api/ba-p/4181292).
27
27
28
28
- question: How do I use Azure API Center with my API management solution?
29
29
answer: |
30
30
Azure API Center is a stand-alone Azure service that's complementary to Azure API Management and API management services from other providers. API Center provides a unified API inventory for all APIs in the organization, including APIs that don't run in API gateways (such as those that are still in design) and those that are managed with different API management solutions.
31
31
32
-
For APIs that are managed using an API management solution, Azure API Center can store metadata such as the runtime environment and deployment details.
32
+
For APIs that are managed using an API management solution, Azure API Center can store metadata such as the runtime environment and deployment details. You can also link Azure API Management services as API sources for you inventory.
33
33
34
34
- question: Does Azure API Center provide a developer portal?
35
35
answer: Yes, you have an option to build and self-host a developer portal where developers can discover APIs in your API center and view API details. A reference implementation is available in the [API Center portal starter](https://github.com/Azure/APICenter-Portal-Starter.git) repository. [Learn more](enable-api-center-portal.md).
36
+
37
+
In the Azure API Center extension for Visual Studio Code, you can also provide an [API catalog](enable-platform-api-catalog-vscode-extension.md) view for app developers in your organization to discover APIs in your API center.
36
38
37
39
- question: Does Azure API Center support availability zones?
38
-
answer: Yes. The Azure API Center service runs in a multitenant environment on availability zone-enabled components. No additional configuration is required to enable availability zones for the service.
40
+
answer: Yes. The Azure API Center service runs in a multitenant environment on availability zone-enabled components. No further configuration is required to enable availability zones for the service.
39
41
40
42
- question: Does my API center's data stay within the region I choose?
41
43
answer: Yes, all data is stored in the region you choose when you create an API center.
@@ -56,4 +58,6 @@ sections:
56
58
additionalContent: |
57
59
## Related content
58
60
59
-
To learn more, see [Azure API Center overview](overview.md).
61
+
* [Azure API Center overview](overview.md)
62
+
* [Build APIs | Microsoft Developer](https://developer.microsoft.com/build-apis
Copy file name to clipboardExpand all lines: articles/api-center/key-concepts.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Key concepts of Azure API Center. API Center inventories an organiz
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: conceptual
7
-
ms.date: 04/23/2024
7
+
ms.date: 11/15/2024
8
8
ms.author: danlep
9
9
---
10
10
@@ -24,7 +24,7 @@ A top-level logical entity in Azure API Center, an API represents any real-world
24
24
25
25
An API in the inventory can be managed by any API management solution, such as Azure [API Management](../api-management/api-management-key-concepts.md), Apigee API Management, Kong Konnect, MuleSoft API Management, or another platform. An API represented in Azure API Center can also be unmanaged.
26
26
27
-
The API inventory in Azure API Center is designed to be created and managed by API program managers or IT administrators.
27
+
The API inventory in Azure API Center is designed to be created and managed by API program managers or IT administrators. Azure API Center also includes features for API developers to register API definitions directly from their development environments, such as Visual Studio Code or CI/CD pipelines.
28
28
29
29
## API version
30
30
@@ -34,6 +34,8 @@ API versioning is the practice of managing changes to an API and ensuring that t
34
34
35
35
Each API version should ideally be defined by at least one definition, such as an OpenAPI definition for a REST API. Azure API Center allows any API definition file formatted as text (YAML, JSON, Markdown, and so on). You can upload OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL, and WADL definitions, among others.
36
36
37
+
To help with API governance, Azure API Center provides linting capabilities to analyze API definitions for quality and compliance with organizational standards.
38
+
37
39
## Environment
38
40
39
41
An environment represents a location where an API runtime could be deployed, for example, an Azure API Management service, an Apigee API Management service, or a compute service such as a Kubernetes cluster, a Web App, or an Azure Function. Each environment is aligned with a lifecycle stage such as development, testing, staging, or production. An environment may also include information about developer portal or management interfaces.
@@ -58,4 +60,5 @@ Azure API Center's metadata schema is compatible with JSON and YAML schema speci
58
60
59
61
*[What is Azure API Center?](overview.md)
60
62
*[Metadata for API governance](metadata.md)
63
+
*[API analysis and linting](enable-managed-api-analysis-linting.md)
Copy file name to clipboardExpand all lines: articles/api-center/overview.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: dlepow
5
5
6
6
ms.service: azure-api-center
7
7
ms.topic: overview
8
-
ms.date: 04/15/2024
8
+
ms.date: 11/15/2024
9
9
ms.author: danlep
10
10
ms.custom: references_regions
11
11
---
@@ -17,7 +17,8 @@ Azure API Center enables tracking all of your APIs in a centralized location for
17
17
With an API center, stakeholders throughout your organization - including API program managers, IT administrators, application developers, and API developers - can discover, reuse, and govern APIs.
18
18
19
19
> [!NOTE]
20
-
> Azure API Center is a solution for design-time API governance and centralized API discovery. Azure also offers the API Management service, a solution for runtime API governance and observability using an API gateway. [Learn more](frequently-asked-questions.yml#what-s-the-difference-between-azure-api-management-and-azure-api-center) about the differences and how Azure API Center and API Management can work together.
20
+
> Azure API Center is a solution for design-time API governance and centralized API discovery. Azure also offers complementary services such as Azure API Management, a solution for runtime API governance and observability using an API gateway. [Learn more](frequently-asked-questions.yml#what-s-the-difference-between-azure-api-management-and-azure-api-center) about the differences and how Azure API Center and API Management can work together.
21
+
21
22
22
23
## Benefits
23
24
@@ -29,15 +30,20 @@ With an API center, stakeholders throughout your organization - including API pr
29
30
30
31
***Accelerate API consumption** - Maximize developer productivity when consuming APIs and ensure they are consumed in a secure manner consistent with organizational standards.
31
32
33
+
32
34
## Key capabilities
33
35
34
36
Create and use an API center for the following:
35
37
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.
38
+
***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, developer tooling such as CI/CD pipelines, and links to API sources such as Azure API Management services.
39
+
40
+
***API design and development** - With the [Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md), developers can register APIs directly from the same development environment where they create their APIs and apps. Developers can take advantage of the extension's integration with GitHub Copilot and GitHub Copilot for Azure to create API definitions from code or natural language descriptions.
37
41
38
42
***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.
39
43
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.
44
+
***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.
45
+
46
+
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.
41
47
42
48
***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.
43
49
@@ -68,7 +74,7 @@ Contoso's API ecosystem includes the following:
68
74
69
75
***API deployment environments** - Contoso deploys a portion of their APIs to Azure App Service. Another subset of their APIs is deployed to an Azure Function app.
70
76
71
-
***Azure API Management** - Contoso uses the Azure [API Management](../api-management/api-management-key-concepts.md) service to manage, publish, and secure their APIs. They use separate instances for Development, Test, and Production, each with a distinct name: APIM-DEV, APIM-TEST and APIM-PROD.
77
+
***Azure API Management** - Contoso uses the Azure [API Management](../api-management/api-management-key-concepts.md) service to manage, publish, and secure their APIs. They use separate instances for Development, Test, and Production, each with a distinct name.
72
78
73
79
***Azure API Center** - Contoso has adopted Azure API Center as their centralized hub for API discovery, governance, and consumption. API Center serves as a structured and organized API hub that provides comprehensive information about all organizational APIs, maintaining related information including versions and associated deployments.
0 commit comments