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: learn-pr/azure/introduction-to-azure-api-management/includes/1-introduction.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
Publishing an application programming interface (API) is a great way to increase market share, generate revenue, and foster innovation. However, maintaining even one API brings significant challenges such as onboarding users, managing revisions, implementing security, and running analytics
1
+
Publishing an application programming interface (API) is a great way to increase market share, generate revenue, and foster innovation. However, maintaining even one API brings significant challenges such as onboarding users, managing revisions, implementing security, and running analytics.
2
2
3
-
Imagine that your organization publishes multiple APIs for different types of users including partners, developers, and employees. These APIs are used in multiple settings, including mobile apps, web apps, and Internet of Things (IoT) devices.
3
+
Imagine that your organization publishes multiple APIs for different types of users, including partners, developers, and employees. These APIs are used in multiple settings, including mobile apps, web apps, and Internet of Things (IoT) devices.
4
4
5
5
:::image type="content" source="../media/1-introduction-before.png" alt-text="Multiple APIs connect to multiple servers, where each API maintains its own set of users, security policies, and analytics data." lightbox="../media/1-introduction-before.png":::
6
6
7
-
Microsoft Azure API Management reduces the complexity of managing all your API traffic, and it offers intuitive portals for managing your APIs as well as surfacing them to developers. It also provides tools for implementing security, managing revisions, and performing analytics.
7
+
Microsoft Azure API Management reduces the complexity of managing all your API traffic. It offers intuitive portals for managing your APIs as well as surfacing them to developers. It also provides tools for implementing security, managing revisions, and performing analytics.
8
8
9
9
:::image type="content" source="../media/1-introduction-after.png" alt-text="Azure API Management acts as a 'front door' for all of an organization's APIs. API calls are then routed to the server where the API is deployed." lightbox="../media/1-introduction-after.png":::
10
10
@@ -18,15 +18,15 @@ Here, you learn how Azure API Management can standardize, centralize, and help s
18
18
19
19
We'll examine Azure API Management to help you decide if it's the correct solution to reduce your company's API complexity by studying these three main components:
20
20
21
-
-**Gateway**. A single endpoint for all your API calls, which eases the implementation of security, rate limits, caching, and transformations.
22
-
-**Administration interface**. A single interface where you import APIs, set policies, create API products, manage users and groups, and run analytics.
23
-
-**Developer portal**. A website that brings all your APIs into a single location for developers to read documentation, test APIs, review code samples, get API keys, and run analytics.
21
+
-**Gateway**: A single endpoint for all your API calls, which eases the implementation of security, rate limits, caching, and transformations.
22
+
-**Administration interface**: A single interface where you import APIs, set policies, create API products, manage users and groups, and run analytics.
23
+
-**Developer portal**: A website that brings all your APIs into a single location for developers to read documentation, test APIs, review code samples, get API keys, and run analytics.
24
24
25
25
We'll also study Azure API Management from these three user angles:
26
26
27
-
-**API consumers**. Entities (such as applications) that get value from using an API.
28
-
-**API providers**. People who administer and maintain APIs.
29
-
-**App developers**. People who build applications that consume APIs.
27
+
-**API consumers**: Entities (such as applications) that get value from using an API.
28
+
-**API providers**: People who administer and maintain APIs.
29
+
-**App developers**: People who build applications that consume APIs.
Copy file name to clipboardExpand all lines: learn-pr/azure/introduction-to-azure-api-management/includes/2-what-is-azure-api-management.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,10 +40,10 @@ The *Azure API Management developer portal* is a fully customizable website that
40
40
41
41
One of the biggest problems with having multiple published APIs is that each API requires a separate set of policies, which is a setting or action that controls the behavior of the API. Azure API Management solves the API policy problem by enabling you to set policies for all your APIs in a single place. You can set policies in many categories, but a partial list includes:
42
42
43
-
-**Access restriction**. These policies determine when an API request is allowed through the gateway. For example, enforce rate limits and usage quotas, filter caller IPs, and check for a valid JSON Web Token (JWT).
44
-
-**Authentication**. Authenticate API calls by using Basic authentication, a client certificate, or a managed identity as examples.
45
-
-**Caching**. Improve API performance by storing and retrieving responses in the cache.
46
-
-**Validation**. Validate API calls by comparing certain parameters to what's in your API specification. For example, validate the request or response body, the request header parameters, and the response headers.
43
+
-**Access restriction**: These policies determine when an API request is allowed through the gateway. For example, enforce rate limits and usage quotas, filter caller IPs, and check for a valid JSON Web Token (JWT).
44
+
-**Authentication**: Authenticate API calls by using Basic authentication, a client certificate, or a managed identity.
45
+
-**Caching**: Improve API performance by storing and retrieving responses in the cache.
46
+
-**Validation**: Validate API calls by comparing certain parameters to what's in your API specification. For example, you can validate the request or response body, the request header parameters, and the response headers.
47
47
48
48
Flexibly combine your policies in *policy definitions*, which are XML documents that consist of a series of statements representing a policy and its parameters. Policy definitions let you configure separate policies at different stages of the API request-response pipeline as shown here:
Copy file name to clipboardExpand all lines: learn-pr/azure/introduction-to-azure-api-management/includes/3-how-azure-api-management-works.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,15 +20,25 @@ If you're an API provider, you still have work to do after your APIs have been p
20
20
21
21
The administration interface enables you to perform the following tasks:
22
22
23
-
**Define and import API specs**: Import an OpenAPI specification, a REST API, a Simple Object Access Protocol (SOAP) API, a WebSocket API, or a GraphQL API. You can also create an API by importing instances of Azure services like Web App, Container App, Function App, Logic App, and Service Fabric. You can also create a blank API and define it manually.
23
+
### Define and import API specs
24
24
25
-
**Manage users and groups**: A *user* is a developer account for an API consumer that you can add manually or invite to create an account. A *group* is a collection of related users that you can associate with a particular API product, and then each group's user has access to the product.
25
+
You can import an OpenAPI specification, a REST API, a Simple Object Access Protocol (SOAP) API, a WebSocket API, or a GraphQL API. You can also create an API by importing instances of Azure services like Web App, Container App, Function App, Logic App, and Service Fabric. In addition, you can create a blank API and define it manually.
26
26
27
-
**Package APIs into products**: A *product* is a group of related APIs. By packaging multiple APIs as a single product, you can configure just the product instead of configuring all the APIs separately. This configuration gets applied to all the APIs in the product, and after published consumers can subscribe with a single subscription key.
27
+
### Manage users and groups
28
28
29
-
**Monitor and analyze APIs**: The administration interface includes built-in monitoring tools to trace and review API traffic in real time and analytics for insights on how consumers are using your published APIs. Azure API Management also supports several Azure tools including Azure Monitor Logs, Application Insights, and Event Hubs.
29
+
A *user* is a developer account for an API consumer that you can add manually or invite to create an account. A *group* is a collection of related users that you can associate with a particular API product, and then each group's user has access to the product.
30
30
31
-
**Manage API revisions and versions**: When your API developer team needs to make changes to an API, expose the change in a safe and controlled manner by using revisions and versions. A *revision* is a relatively minor or nonbreaking change to an API. Your development team can code and test the revision separately from the production API, and then set the updated API as the current revision once ready as in the following image. A *version* is a relatively major or breaking change to an API. Azure API Management enables you to offer developers multiple versions of the API simultaneously and offers several versioning schemes.
31
+
### Package APIs into products
32
+
33
+
A *product* is a group of related APIs. By packaging multiple APIs as a single product, you can configure just the product instead of configuring all the APIs separately. This configuration gets applied to all the APIs in the product, and after published consumers can subscribe with a single subscription key.
34
+
35
+
### Monitor and analyze APIs
36
+
37
+
The administration interface includes built-in monitoring tools to trace and review API traffic in real time and analytics for insights on how consumers are using your published APIs. Azure API Management also supports several Azure tools including Azure Monitor Logs, Application Insights, and Event Hubs.
38
+
39
+
### Manage API revisions and versions
40
+
41
+
When your API developer team needs to make changes to an API, expose the change in a safe and controlled manner by using revisions and versions. A *revision* is a relatively minor or nonbreaking change to an API. Your development team can code and test the revision separately from the production API, and then set the updated API as the current revision once ready as in the following image. A *version* is a relatively major or breaking change to an API. Azure API Management enables you to offer developers multiple versions of the API simultaneously and offers several versioning schemes.
32
42
33
43
:::image type="content" source="../media/3-how-azure-api-management-works-revisions.png" alt-text="Depiction of how revisions work in Azure API Management. API requests from consumers are routed to the current revision of the API, whereas API requests from the in-house development team are routed to the API revision." lightbox="../media/3-how-azure-api-management-works-revisions.png":::
34
44
@@ -37,7 +47,7 @@ The administration interface enables you to perform the following tasks:
37
47
Except for the Consumption tier, all Azure API Management instances include a developer portal where you surface your APIs to potential and existing API consumers. The developer portal comes with a default interface that's customizable to match your organization's branding and requirements. Once signed in, developers are presented with a web interface that enables them to interact with APIs in the following ways:
38
48
39
49
-**Accessing API documentation**: Developers can review the documentation you've provided for each API.
40
-
-**Testing an API**: The developer portal offers an interactive console that enables a developer to test an API quickly and safely.
41
-
-**Reviewing API code samples**: The developer portal offers API call samples in several programming languages, including C#, Java, JavaScript, PHP, and Python.
42
-
-**Subscribing to an API**: When a consumer decides to use your API, the developer portal enables the user to create a subscription to the API and obtain a subscription key to use when calling the API.
43
-
-**Running analytics**: The developer portal offers analytics on the developer's usage of an API.
50
+
-**Testing an API**: Offers an interactive console that enables a developer to test an API quickly and safely.
51
+
-**Reviewing API code samples**: API call samples in several programming languages, including C#, Java, JavaScript, PHP, and Python.
52
+
-**Subscribing to an API**: When a consumer decides to use your API, it enables the user to create a subscription to the API and obtain a subscription key to use when calling the API.
53
+
-**Running analytics**: Includes analytics on the developer's usage of an API.
Copy file name to clipboardExpand all lines: learn-pr/azure/introduction-to-azure-api-management/includes/4-when-to-use-azure-api-management.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
Now let's discuss some scenarios that illustrate when it's appropriate to use Azure API Management. Let's investigate API lifecycle management with respect to standardizing APIs, centralizing API management and exposure, and enhancing API security. These don't apply equally to all use cases, but let's look deeper at each one.
1
+
Now let's discuss some scenarios that illustrate when it's appropriate to use Azure API Management. Let's investigate API lifecycle management with respect to standardizing APIs, centralizing API management and exposure, and enhancing API security. These don't apply equally to all use cases, but we'll look deeper at each one.
2
2
3
-
### Should you use Azure API Management to standardize APIs?
3
+
### Standardize APIs
4
4
5
5
By enabling management of multiple APIs from a single administrative interface, Azure API Management makes it easier to create consistency across multiple APIs. You can standardize many API features, including:
6
6
@@ -14,13 +14,13 @@ By enabling management of multiple APIs from a single administrative interface,
14
14
15
15
This is true of the food delivery scenario, which requires consistency across the APIs for consumers.
16
16
17
-
### Should you use Azure API Management to centralize API operations?
17
+
### Centralize API operations
18
18
19
19
Azure API Management enhances the centralization of all API operations by bringing multiple APIs under a single administrative umbrella. Centralizing API operations can result in better admin operations, deployment centralization, and enhanced developer access.
20
20
21
21
All these factors apply to our food delivery scenario. Centralized consumer access through the developer portal makes it easier to sign up new developers, enhancing the monetization of the platform's APIs.
22
22
23
-
### Should you use Azure API Management to secure access to your APIs?
23
+
### Secure access to your APIs
24
24
25
25
Azure API Management was designed with API security in mind. So many organizations rely on APIs for the internal and external exchange of data between apps and devices. A proper API security strategy covers the following bases:
0 commit comments