Skip to content

Commit c956515

Browse files
authored
Merge pull request #239641 from MicrosoftDocs/release-preview-api-center
API Center public preview--scheduled release at 10AM of 6/15
2 parents c0377ff + 2ad2fed commit c956515

File tree

12 files changed

+470
-0
lines changed

12 files changed

+470
-0
lines changed

articles/api-center/TOC.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
- name: Azure API Center Documentation
2+
href: index.yml
3+
- name: Overview
4+
expanded: true
5+
items:
6+
- name: What is API Center?
7+
displayName: Overview
8+
href: overview.md
9+
- name: Service limits
10+
href: ../azure-resource-manager/management/azure-subscription-service-limits.md#api-center-preview-limits
11+
- name: Concepts
12+
items:
13+
- name: Key concepts
14+
href: key-concepts.md
15+
- name: Tutorials
16+
items:
17+
- name: Set up an API center
18+
href: set-up-api-center.md
19+
- name: Reference
20+
items:
21+
- name: REST API
22+
href: https://aka.ms/apicenter/docs/rest
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
3+
title: Include file
4+
description: Include file
5+
services: api-center
6+
author: dlepow
7+
8+
ms.service: api-center
9+
ms.topic: include
10+
ms.date: 05/24/2023
11+
ms.author: danlep
12+
ms.custom: Include file
13+
---
14+
15+
> [!NOTE]
16+
> API Center is in preview. During preview, request features, report bugs, or provide other feedback in this [GitHub repo](https://aka.ms/apicenter/preview/feedback).
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
3+
title: Include file
4+
description: Include file
5+
services: api-center
6+
author: dlepow
7+
8+
ms.service: api-center
9+
ms.topic: include
10+
ms.date: 05/17/2023
11+
ms.author: danlep
12+
ms.custom: Include file
13+
---
14+
15+
| Resource | Limit<sup>1</sup> |
16+
| ---------------------------------------------------------------------- | -------------------------- |
17+
| Maximum number of APIs | 1,000 |
18+
| Maximum number of versions per API | 100 |
19+
| Maximum number of environments | 1,000 |
20+
| Maximum number of custom metadata properties | 100 |
21+
| Maximum number of child properties in custom metadata property of type "object" | 100 |
22+
23+
<sup>1</sup> To increase an API Center limit, contact [support](https://azure.microsoft.com/support/options/).<br/>

articles/api-center/index.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
### YamlMime:Landing
2+
3+
title: Azure API Center (preview) documentation
4+
summary: API Center helps you develop and maintain a structured inventory of your organization's APIs. API Center enables API discovery, reuse, and governance at scale.
5+
6+
metadata:
7+
title: Azure API Center documentation | Microsoft Docs
8+
description: Azure API Center helps you develop and maintain a structured inventory of your organization's APIs. API Center enables API discovery, reuse, and governance at scale.
9+
ms.service: api-center
10+
ms.topic: landing-page
11+
ms.collection:
12+
author: dlepow
13+
ms.author: danlep
14+
ms.date: 05/24/2023
15+
16+
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | whats-new
17+
18+
landingContent:
19+
# Cards and links should be based on top customer tasks or top subjects
20+
# Start card title with a verb
21+
# Card
22+
- title: About API Center
23+
linkLists:
24+
- linkListType: overview
25+
links:
26+
- text: What is API Center?
27+
url: overview.md
28+
- text: Key concepts
29+
url: key-concepts.md
30+
- linkListType: get-started
31+
links:
32+
- text: Tutorial - Set up your API center
33+
url: set-up-api-center.md

articles/api-center/key-concepts.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Azure API Center (preview) - Key concepts
3+
description: Key concepts of Azure API Center. API Center enables tracking APIs in a centralized location for discovery, reuse, and governance.
4+
author: dlepow
5+
editor: ''
6+
7+
ms.service: api-center
8+
ms.topic: conceptual
9+
ms.date: 06/05/2023
10+
ms.author: danlep
11+
ms.custom:
12+
---
13+
14+
# Azure API Center (preview) - key concepts
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.
17+
18+
[!INCLUDE [api-center-preview-feedback](includes/api-center-preview-feedback.md)]
19+
20+
## API
21+
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.
23+
24+
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+
26+
## API version
27+
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.
29+
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.
31+
32+
## Environment
33+
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.
35+
36+
## Deployment
37+
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.
39+
40+
## Metadata and metadata schema
41+
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.
43+
44+
API Center supports properties of type array, boolean, number, object, predefined choices, and string.
45+
46+
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+
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).
51+
52+
## Next steps
53+
54+
* [Set up your API center](set-up-api-center.md)
55+
65.3 KB
Loading
90.4 KB
Loading
34 KB
Loading
184 KB
Loading

articles/api-center/overview.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Azure API Center (preview) - Overview
3+
description: Introduction to key scenarios and capabilities of Azure API Center. API Center inventories an organization's APIs to promote API discovery, reuse, and governance at scale.
4+
author: dlepow
5+
editor: ''
6+
7+
ms.service: api-center
8+
ms.topic: overview
9+
ms.date: 06/05/2023
10+
ms.author: danlep
11+
ms.custom: references_regions
12+
---
13+
14+
# What is Azure API Center (preview)?
15+
16+
API Center enables tracking all of your APIs in a centralized location for discovery, reuse, and governance. Use API Center to develop and maintain a structured and organized inventory of your organization's APIs - regardless of their type, lifecycle stage, or deployment location - along with related information such as version details, specification files, and common metadata.
17+
18+
[!INCLUDE [api-center-preview-feedback](includes/api-center-preview-feedback.md)]
19+
20+
> [!NOTE]
21+
> API Center is a solution for API inventory management. If you're looking for a solution to manage, secure, and publish your organization's API backends through an API gateway, see the [Azure API Management](../api-management/api-management-key-concepts.md) service.
22+
23+
## Benefits
24+
25+
With API Center, stakeholders throughout your organization - including API program managers, application developers, and API developers - can discover, govern, and reuse APIs.
26+
27+
* **API program managers**, usually IT or enterprise architects leading organizational API programs, who foster API reuse, quality, and compliance. API Center provides these users with a centralized inventory view of all APIs in the organization and information about those APIs, such as their deployments.
28+
* **Application developers**, including both professional developers and low-code/no-code developers, who discover and consume APIs to accelerate or enable development of applications. API Center helps these users find, understand, and get access to available APIs and reach the API developer teams who support them.
29+
* **API developers**, who design, develop, document, and publish APIs that meet organizational standards and comply with industry regulations. API Center helps these users reduce duplication, boost adoption, and track their APIs throughout their lifecycles.
30+
31+
## Key capabilities
32+
33+
In preview, create and use an API Center in the Azure portal for the following:
34+
35+
* **API inventory management** - Register all of your organization's APIs for inclusion in a centralized inventory.
36+
* **Real-world API representation** - Add real-world information about each API including versions and specifications such as OpenAPI specifications. List API deployments and associate them with runtime environments, for example representing API management solutions.
37+
* **Metadata properties** - Organize and filter APIs and related resources using built-in and custom metadata properties, to help with API governance and discoverability by API consumers.
38+
* **Workspaces** - Enable multiple teams to work independently in API Center by creating workspaces with permissions based on role-based access control.
39+
40+
For more information about the information assets and capabilities in API Center, see [Key concepts](key-concepts.md).
41+
42+
## Preview limitations
43+
44+
* In preview, API Center is available in the following Azure regions:
45+
46+
* East US
47+
* UK South
48+
* Central India
49+
* Australia East
50+
51+
## Frequently asked questions
52+
53+
### Q: Is API Center part of Azure API Management?
54+
55+
A: 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.
56+
57+
### Q: Is my data encrypted in API Center?
58+
59+
A: Yes, all data in API Center is encrypted at rest.
60+
61+
## Next steps
62+
63+
> [!div class="nextstepaction"]
64+
> [Get access to the preview](https://aka.ms/apicenter/joinpreview)
65+
66+
67+
> [!div class="nextstepaction"]
68+
> [Set up your API center](set-up-api-center.md)
69+
70+
> [!div class="nextstepaction"]
71+
> [Provide feedback](https://aka.ms/apicenter/preview/feedback)

0 commit comments

Comments
 (0)