Skip to content

Commit a6ad6ca

Browse files
authored
Merge pull request #310973 from GitHubber17/543869-c
Freshness Edit: API Center
2 parents 06a108e + edffe4e commit a6ad6ca

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,64 @@
11
---
2-
title: Azure API Center - Key concepts
3-
description: Key concepts of Azure API Center. API Center inventories an organization's APIs for discovery, reuse, and governance at scale.
2+
title: Azure API Center - Key Concepts
3+
description: Explore the key concepts of Azure API Center that lets you inventory an organization's APIs for discovery, reuse, and governance at scale.
44
author: dlepow
55
ms.service: azure-api-center
6-
ms.topic: conceptual
7-
ms.date: 11/15/2024
6+
ms.topic: concept-article
7+
ms.date: 01/28/2026
88
ms.author: danlep
99
---
1010

1111
# Azure API Center - key concepts
1212

13-
This article explains key concepts of [Azure API Center](overview.md). Azure API Center enables tracking APIs in a centralized location for discovery, reuse, and governance.
13+
Explore the key concepts of [Azure API Center](overview.md), which lets you track APIs in a centralized location for discovery, reuse, and governance.
1414

1515
## Data model
1616

17-
The following diagram shows the main entities in Azure API Center and how they relate to each other. See the following sections for more information about these entities and related concepts.
17+
The main entities in an Azure API Center configuration include your APIs and their versions, definitions, and deployments. The possible runtime environments for each API and descriptive metadata supplement the configuration.
1818

19-
:::image type="content" source="media/key-concepts/api-center-data-model.png" alt-text="Diagram that shows key features of the data model in Azure API Center." border="true":::
19+
The following diagram shows the main entities and how they relate to each other.
20+
21+
:::image type="content" source="media/key-concepts/api-center-data-model.png" border="false" alt-text="Diagram that shows the key features of the data model in Azure API Center.":::
2022

2123
## API
2224

2325
A top-level logical entity in Azure API Center, an API represents any real-world API that you want to track. An API center can include APIs of any type, including REST, GraphQL, gRPC, SOAP, WebSocket, and Webhook.
2426

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.
27+
You can manage an API in the inventory by any API management solution. For example, use 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.
2628

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.
29+
API program managers or IT administrators can create and manage the API inventory in Azure API Center. 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.
2830

2931
## API version
3032

31-
API versioning is the practice of managing changes to an API and ensuring that these changes are made without disrupting clients. An API can have multiple versions across lifecycle stages, each aligned with specific API changes. Some versions may introduce major or breaking changes, while others add minor improvements. An API version can be at any lifecycle stage from design, to preview, production, or deprecated.
33+
API versioning is the practice of managing changes to an API and ensuring the changes are made without disrupting clients. An API can have multiple versions across lifecycle stages, each aligned with specific API changes. Some versions might introduce major or breaking changes, while others add minor improvements. An API version can be at any lifecycle stage from design, to preview, production, or deprecated.
3234

3335
## API definition
3436

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.
37+
There should be at least one definition for each API version, 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.
3638

3739
To help with API governance, Azure API Center provides linting capabilities to analyze API definitions for quality and compliance with organizational standards.
3840

3941
## Environment
4042

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.
43+
An environment represents a location where an API runtime is deployable such as an Azure API Management service or an Apigee API Management service. You might also deploy to a compute service like a Kubernetes cluster, Web App, or Azure Functions app. Each environment is aligned with a lifecycle stage such as development, testing, staging, or production. An environment might also include information about developer portal or management interfaces.
4244

4345
> [!NOTE]
44-
> Use Azure API Center to track any of your API runtime environments, whether or not they're hosted on Azure infrastructure. These environments aren't the same as Azure Deployment Environments.
46+
> Use Azure API Center to track any of your API runtime environments, regardless of whether they're hosted on Azure infrastructure. These environments aren't the same as Azure Deployment Environments.
4547
4648
## Deployment
4749

4850
A deployment is a location (an address) where users can access an API. An API can have multiple deployments, such as different staging environments or regions. For example, an API could have one deployment in an internal staging environment and a second in a production environment. Each deployment is associated with a specific API definition.
4951

5052
## Metadata
5153

52-
In Azure API Center, organize your APIs, deployments, and other entities by setting metadata values, which can be used for search and filtering and to enforce governance standards. An API center provides several common built-in metadata properties such as "API type" and "lifecycle stage". The API center owner can augment the built-in metadata by defining custom metadata in a metadata schema to organize their APIs, deployments, and environments. For example, create an *API approver* property to identify the individual responsible for approving an API for use.
54+
In Azure API Center, organize your APIs, deployments, and other entities by setting metadata values. The metadata is useful for searching and filtering and enforcing governance standards. An API center provides several common built-in metadata properties such as `API type` and `lifecycle stage`. The API center owner can augment the built-in metadata by defining custom metadata in a metadata schema to organize their APIs, deployments, and environments. For example, create an `API approver` metadata property to identify the individual responsible for approving an API for use.
5355

5456
Azure API Center supports custom metadata of type array, boolean, number, object, predefined choices, and string.
5557

5658
Azure API Center's metadata schema is compatible with JSON and YAML schema specifications, to allow for schema validation in developer tooling and automated pipelines.
5759

58-
5960
## Related content
6061

61-
* [What is Azure API Center?](overview.md)
62-
* [Metadata for API governance](metadata.md)
63-
* [API analysis and linting](enable-managed-api-analysis-linting.md)
64-
62+
- [What is Azure API Center?](overview.md)
63+
- [Metadata for API governance](metadata.md)
64+
- [API analysis and linting](enable-managed-api-analysis-linting.md)

0 commit comments

Comments
 (0)