Skip to content

Commit e74fe85

Browse files
committed
Line edits2
1 parent a17cb6f commit e74fe85

File tree

3 files changed

+21
-57
lines changed

3 files changed

+21
-57
lines changed

learn-pr/azure/introduction-to-azure-api-management/includes/3-how-azure-api-management-works.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ The gateway performs many tasks from the consumer's point of view, but the follo
1616

1717
## Azure API Management for API providers
1818

19-
If you're an API provider, you still have a great deal of work to do after your APIs have been published. This work includes setting API policies, managing API consumers, managing API revisions and versions, and monitoring and analyzing your APIs. You can perform these tasks using the Azure API Management administration interface, Azure CLI, or Azure Powershell.
19+
If you're an API provider, you still have work to do after your APIs have been published. This work includes setting API policies, managing API consumers, managing API revisions and versions, and monitoring and analyzing your APIs. You can perform these tasks using the Azure API Management administration interface, Azure CLI, or Azure Powershell.
2020

21-
The administration interface also enables you to perform the following tasks:
21+
The administration interface enables you to perform the following tasks:
2222

2323
- **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 the following Azure services: Web App, Container App, Function App, Logic App, and Service Fabric. You can also create a blank API and define it manually.
2424
- **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.
Lines changed: 15 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,34 @@
1-
Now let's discuss some scenarios that illustrate when it's appropriate to use Azure API Management. Using the food delivery service as an example, let's investigate API lifecycle management with respect to standardizing APIs, centralizing API management and exposure, and enhancing API security. We can use the following criteria to help you decide whether Azure API Management is a suitable choice for managing and publishing your organization's inventory of APIs:
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.
22

3-
## Decision criteria
4-
5-
| **Criteria** | **Analysis**|
6-
| --- | --- |
7-
| **Number of APIs** | The key consideration is the number of APIs that you manage. The more APIs you've deployed, the greater the need for deployment standardization and centralization of API control. |
8-
| **Rate of API changes** | The next consideration is the rate at which your organization implements API revisions and versions. The faster you create API revisions and publish new API versions, the greater the need for a robust and flexible versioning control system. |
9-
| **API administration load** | The last consideration is how much policy overhead you apply to your APIs. Policies such as usage quotas, call rate limits, request transformations, and request validation. The more configurations and options your APIs require, the greater the need for standardized and centralized policy implementations. |
10-
11-
## Apply the criteria
12-
13-
Azure API Management is the correct choice for managing APIs through their lifecycles when you have a large API deployment that changes frequently and requires significant policy overhead. However, these criteria don't apply equally to all use cases. Let's consider how these criteria apply to the use cases for our scenario.
3+
To help you decide whether Azure API Management is a suitable choice, consider the number of APIs you manage, the rate of API changes, and the API administration load. These criteria don't apply equally to all use cases, but let's look deeper at each one.
144

155
### Should you use Azure API Management to standardize APIs?
166

177
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:
188

19-
- **Specifications**. Standardizing API specs—such as using REST for all APIs and using a consistent naming scheme for JSON name-value pairs—reduces development time, decreases errors, and enables your organization to respond faster to customer suggestions and market forces.
20-
- **Documentation**. Standardizing API documentation enables developers to get up to speed with an API quickly. It also reduces technical support queries and encourages developers to use more of your APIs.
21-
- **URLs**. Standardizing the base URL for your APIs reduces consumer errors and gives your API deployments a more professional appearance.
22-
- **Analytics**. Standardizing API analytics enables management teams and engineers to compare usage and performance across multiple APIs.
23-
- **Regulations**. For APIs that must meet government or industry rules and regulations, standardization helps ensure compliance across all APIs.
9+
- **Specifications**: Reduces development time, decreases errors, and enables your organization to respond faster to customer suggestions and market forces.
10+
- **Documentation**: Enables developers to get up to speed with an API quickly, reduces technical support queries, and encourages developers to use more of your APIs.
11+
- **URLs**: Rreduces consumer errors and gives your API deployments a more professional appearance.
12+
- **Analytics**: Enables management teams and engineers to compare usage and performance across multiple APIs.
13+
- **Regulations**: Helps ensure compliance toward government or industry rules and regulations across all APIs.
2414

2515
:::image type="content" source="../media/4-when-to-use-azure-api-management-standardization.png" alt-text="Several APIs with varying configurations are imported into Azure API Management. When they emerge from API Management, they have standardized configurations." lightbox="../media/4-when-to-use-azure-api-management-standardization.png":::
2616

27-
In most cases, the need for standardization expands as:
28-
29-
- The number of APIs grows.
30-
- The rate at which the APIs are revised increases.
31-
- The API administration load gets larger.
32-
33-
This need is true of the food delivery platform scenario, which requires consistency across the APIs for the mobile app, the web app, and the partner restaurants.
17+
This is true of the food delivery scenario, which requires consistency across the APIs for the consumers.
3418

3519
### Should you use Azure API Management to centralize API operations?
3620

37-
Azure API Management enhances the centralization of all API operations by bringing multiple APIs under a single administrative umbrella. Without an API management service, each API is on its own in terms of administration, deployment, and developer access. This decentralized model often results in duplicated efforts and increased overhead. Centralizing API operations can result in the following benefits:
38-
39-
- **Administration**. Apply administrative operations—such as policy creation, user management, and analytics—in a single location such as the administrative interface provided by Azure API Management. Centralizing admin tasks makes running these tasks simpler and more efficient.
40-
- **Deployment**. Route all API requests through a single base URL, such as the endpoint created by the Azure API Management gateway. Deployment centralization makes it easier to enforce policies and apply transformations.
41-
- **Developer access**. Place all developer resources—such as documentation, code samples, testing, and subscriptions—in a single location such as the developer portal in Azure API Management. Centralizing developer access makes it easier for developers to find and use your APIs.
21+
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.
4222

43-
The efficiencies that accrue from centralizing API operations tend to increase with the number of APIs and with the overall administrative load size you impose on your APIs. Having centralized APIs is a huge help when APIs are frequently updated because it enables a single versioning scheme for all products.
44-
45-
All these factors apply strongly to our food delivery platform scenario. For example, centralized consumer access through the developer portal makes it easier to sign up new developers, enhancing the monetization of the platform's APIs.
23+
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.
4624

4725
### Should you use Azure API Management to secure access to your APIs?
4826

49-
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 haphazard or inconsistent approach to security is just asking for trouble. A proper API security strategy covers the following bases:
50-
51-
- **Permissions**. Control who can work with an API and what they can do with it. In Azure API Management, having all your API consumers as users and being able to organize those users into groups makes it easier and more efficient to apply permissions to control API access.
52-
- **Access**. Only allow authorized users to submit requests. With Azure API Management, the developer portal supplies users with subscription keys, and you can restrict access to APIs by using multiple forms of authentication and JSON web tokens.
53-
- **Protection**. Secure the API from malicious usage. Azure API Management enables you to throttle API access by using rate limits and usage quotas to help prevent consumer misuse (intentional or accidental) of the API.
54-
- **Compliance**. Make sure your APIs satisfy all corporate or government security policies. Having all your APIs together in Azure API Management makes it easier to configure those APIs with security policies that achieve compliance.
27+
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:
5528

56-
The more APIs you manage, the greater the need for security. Having more APIs, means a greater attack surface and a greater risk of accidental data breaches or leaks. Also, the more often you revise your APIs, the greater the chance that a revision or new version can uncover a security flaw.
29+
- **Permissions**. Control who can work with an API and what they can do with it.
30+
- **Access**. Only allow authorized users to submit requests.
31+
- **Protection**. Secure the API from malicious usage.
32+
- **Compliance**. Make sure your APIs satisfy all corporate or government security policies.
5733

5834
These security concerns are paramount in our food delivery scenario. Our platform generates and stores a great deal of sensitive data, including restaurant payments, customer names and addresses, and delivery vehicle locations.

learn-pr/azure/introduction-to-azure-api-management/includes/6-summary.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,10 @@
1-
Our goal in this module was to help you evaluate whether Azure API Management is appropriate for managing and publishing your organization's APIs. To help you make that decision, we presented some criteria you can use:
1+
Our goal in this module was to help you evaluate whether Azure API Management is appropriate for managing and publishing your organization's APIs. To help you make that decision, we presented criteria you can use including number of APIs, rate of API changes, and API admin load.
22

3-
- Number of APIs
4-
- Rate of API changes
5-
- API administration load
3+
We applied these criteria in the context of our fictional food delivery organization. You learned that in most scenarios, Azure API Management offers improved API standardization, enhanced centralization of API operations, and tightened API security.
64

7-
We applied these criteria in the context of our fictional food delivery organization. The criteria helped you evaluate whether your organization's APIs would benefit from being gathered under the umbrella of Azure API Management. You learned that in most scenarios, Azure API Management offers the following benefits:
5+
However, you also learned that some organizations might not benefit from using Azure API Management. This is true if they have a small number of deployed APIs, mostly static APIs, or APIs requiring few policies, users, and analytics.
86

9-
- Improved API standardization through enabling management of multiple APIs from a single administrative interface.
10-
- Enhanced centralization of all API operations by bringing multiple APIs under a single administrative umbrella.
11-
- Tightened API security resulting from permissions, access control policies, and attack surface reduction.
12-
13-
However, you also learned that some organizations might not benefit from using Azure API Management if they have:
14-
15-
- A relatively small number of deployed APIs.
16-
- APIs that are mostly static or require few revisions.
17-
- APIs that require few, if any, administrative extras such as policies, users, and analytics.
18-
19-
The *API economy*—how API usage by developers and their consumers generates important revenue streams for the companies that publish the APIs, increasingly drives today's connected world. If you want to maximize your API economy, use the criteria in this module to assess how Azure API Management can help your organization improve. Especially, its ability to adapt APIs to satisfy consumers, follow business trends, and take advantage of new opportunities. The process you went through here should give you enough information to choose the correct API lifecycle management solution for your organization.
7+
The API economy increasingly drives today's connected world. If you want to maximize your API economy, use the criteria in this module to assess your ability to adapt APIs to satisfy consumers, follow business trends, and take advantage of new opportunities. The process you went through here should give you enough information to choose the correct API lifecycle management solution for your organization.
208

219
## References
2210

0 commit comments

Comments
 (0)