Skip to content

Commit 9a11821

Browse files
author
Jill Grant
authored
Merge pull request #248784 from dlepow/apicp
[API Center] Preview updates
2 parents 12f6aa8 + 694d360 commit 9a11821

15 files changed

+131
-79
lines changed

articles/api-center/TOC.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,12 @@
1919
- name: Reference
2020
items:
2121
- name: REST API
22-
href: https://aka.ms/apicenter/docs/rest
22+
href: /rest/api/apicenter/
23+
- name: REST API SDKs
24+
items:
25+
- name: JavaScript
26+
href: /javascript/api/overview/azure/apicenter
27+
- name: Java
28+
href: /java/api/overview/azure/apicenter
29+
- name: Python
30+
href: https://pypi.org/project/azure-mgmt-apicenter

articles/api-center/key-concepts.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,59 @@ editor: ''
66

77
ms.service: api-center
88
ms.topic: conceptual
9-
ms.date: 06/05/2023
9+
ms.date: 08/18/2023
1010
ms.author: danlep
1111
ms.custom:
1212
---
1313

1414
# Azure API Center (preview) - key concepts
1515

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

1818
[!INCLUDE [api-center-preview-feedback](includes/api-center-preview-feedback.md)]
1919

20+
## Data model
21+
22+
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+
2032
## API
2133

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

2436
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.
2537

26-
## API version
38+
## Environment
2739

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

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
3143

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

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

3650
## Deployment
3751

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

40-
## Metadata and metadata schema
54+
## Metadata properties
4155

42-
In API Center, you organize your APIs and 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.
4357

4458
API Center supports properties of type array, boolean, number, object, predefined choices, and string.
4559

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

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).
5162

5263
## Next steps
5364

108 KB
Loading
27.8 KB
Loading
16.6 KB
Loading
-46.3 KB
Loading
-61.4 KB
Loading
20.4 KB
Loading
Binary file not shown.
18 KB
Loading

0 commit comments

Comments
 (0)