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/key-concepts.md
+25-14Lines changed: 25 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,48 +6,59 @@ editor: ''
6
6
7
7
ms.service: api-center
8
8
ms.topic: conceptual
9
-
ms.date: 06/05/2023
9
+
ms.date: 08/18/2023
10
10
ms.author: danlep
11
11
ms.custom:
12
12
---
13
13
14
14
# Azure API Center (preview) - key concepts
15
15
16
-
This article goes into more detail about key concepts of [Azure API Center](overview.md). API Center enables tracking APIs in a centralized location for discovery, reuse, and governance.
16
+
This article explains key concepts of [Azure API Center](overview.md). API Center enables tracking APIs in a centralized location for discovery, reuse, and governance.
The following diagram shows the main entities in API Center and how they relate to each other. See the following sections for more information about each entity.
23
+
24
+
:::image type="content" source="media/key-concepts/api-center-data-model.png" alt-text="Diagram that shows the data model in API Center." border="false":::
25
+
26
+
### Highlighted relationships
27
+
28
+
1. Each **API** can have multiple **versions** and multiple real-world **deployments**.
29
+
1. Each API **version** can have multiple API **definitions**.
30
+
1. Each API **deployment** is associated with a specific **environment** and a specific API **definition** file.
31
+
20
32
## API
21
33
22
-
A top-level logical entity in API Center that represents any real-world API. API Center supports APIs of any type, including REST, GraphQL, gRPC, SOAP, WebSocket, and Webhook.
34
+
A top-level logical entity in API Center, an API represents any real-world API that you want to track. API Center supports APIs of any type, including REST, GraphQL, gRPC, SOAP, WebSocket, and Webhook.
23
35
24
36
An API can be managed by any API management solution (such as Azure [API Management](../api-management/api-management-key-concepts.md) or solutions from other providers), or unmanaged.
25
37
26
-
## API version
38
+
## Environment
27
39
28
-
APIs typically have multiple versions across lifecycle stages. In API Center, associate one or more versions with each API, 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.
40
+
In API Center, an environment represents a location where an API runtime could be deployed, typically an API management platform, API gateway, or compute service. Each environment has a type (such as production or staging) and may include information about developer portal or management interfaces.
29
41
30
-
Each API version may be defined with a specification file, such as an OpenAPI definition for a REST API. API Center allows any specification file formatted as text (YAML, JSON, markdown, and so on). You can upload OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL, and WADL specifications, among others.
42
+
##API version
31
43
32
-
## Environment
44
+
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
45
34
-
Use API Center to maintain information about your APIs' environments. An environment represents a location where an API runtime could be deployed, typically an API management platform, API gateway, or compute service. Each environment has a type (such as production or staging) and may include information about developer portal or management interfaces.
46
+
## API definition
47
+
48
+
Each API version may be defined with one or more definition files, such as an OpenAPI definition for a REST API. 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. API Center also supports importing API definitions from a URL.
35
49
36
50
## Deployment
37
51
38
-
In API Center, a deployment identifies a specific environment used for the runtime of an API version. For example, an API version could have two deployments: a deployment in a staging Azure API Management service and a deployment in a production Azure API Management service.
52
+
In API Center, a deployment identifies a specific environment used for an API runtime. An API could have multiple deployments, for example, one deployment in a staging Azure API Management service and a second deployment in a production Azure API Management service. Each deployment is associated with a specific API definition.
39
53
40
-
## Metadata and metadata schema
54
+
## Metadata properties
41
55
42
-
In API Center, you organize your APIsand other assets by setting values of metadata properties, which can be used for searching and filtering and to enforce governance standards. API Center provides several common built-in properties such as "API type" and "Lifecycle". An API Center owner can augment the built-in properties by defining custom properties in a metadata schema to organize their APIs, deployments, and environments according to their organization's requirements. For example, create a *Line of business* property to identify the business unit that owns an API.
56
+
In API Center, you organize your APIs, deployments, and other entities by setting values of metadata properties, which can be used for searching and filtering and to enforce governance standards. API Center provides several common built-in properties such as "API type" and "Version lifecycle". An API Center owner can augment the built-in properties by defining custom properties in a metadata schema to organize their APIs, deployments, and environments according to their organization's requirements. For example, create a *Line of business* property to identify the business unit that owns an API.
43
57
44
58
API Center supports properties of type array, boolean, number, object, predefined choices, and string.
45
59
46
60
API Center's metadata schema is compatible with JSON and YAML schema specifications, to allow for schema validation in developer tooling and automated pipelines.
47
61
48
-
## Workspace
49
-
50
-
To enable multiple teams to work independently in a single deployment, API Center provides workspaces. Similar to API Management [workspaces](../api-management/workspaces-overview.md), workspaces in API Center allow separate teams to access and manage a part of the API inventory. Access is controlled through Azure role-based access control (RBAC).
0 commit comments