开始使用 Azure API 管理

Gaurav Aroraa

5.00/5 (6投票s)

2015 年 3 月 26 日

CPOL

7分钟阅读

53886

在本文中，我们将讨论 Azure API 管理的基础知识，以管理我们的 Web API。

引言

在本文中，我们将讨论 Azure Management 的所有基础知识，以管理我们的 Web API。在此，我们不讨论 Azure Management 的工作原理，以及如何创建虚拟机、创建云应用和在 Azure 上托管应用，尽管我们的重点将仅限于使用 Azure Management 管理 Web API。

在本文中，我们将

创建一个 ASP.NET WEB API
将我们的服务托管/部署到 Azure
使用 Azure API 管理管理我们的服务

先决条件

要学习本文，我们需要

Visual Studio 2013 或更高版本（您可以使用社区版）
SqlServer 2012 或更高版本（您可以使用 Express 版）
ORM 基础知识（我们将在演示应用程序中使用 FluentNHibernate）
ASP.NET WEB API 基础知识
RESTful 服务基础知识
有效的 Windows Azure 订阅（如果您没有，请获取一个月的免费订阅）

让我们开发一个简单的 ASP.NET WEB API

为达到目的，我们需要 ASP.NET WEB API，它托管在服务器上。在本文中，我们不讨论如何创建 ASP.NET WEB API。

要了解有关如何创建 ASP.NET WEB API 的更多信息，请参阅本文：使用 FluentNHibernate、Repository Pattern 进行 ASP.NET Web API 的 CRUD 操作。

托管/部署我们的服务到 Azure

希望您已阅读前一节中提到的文章。现在，如果您还没有下载演示项目，请下载。否则，您可以在此处找到完整的源代码：WEB API 的 Crudd 操作。

现在，让我们将上面创建的服务部署到我们的 Azure 服务器。

在解决方案资源管理器中，右键单击并选择“发布”
我们将 ASP.NET WEB API 部署/发布为 Azure 网站，因此我们可以获得一个强大的端点——我们将在接下来的会话/文章中讨论这一点。
然后，单击“发布”。
几分钟后，我们的 WEB API 将可用。
通过浏览 URL 进行检查：Crud With Web API。

让我们继续设置我们的 Azure API 管理。

使用 AZURE MANAGEMENT

现在，我们已经准备好了 WEB API，可以使用 AZURE MANAGEMENT 进行托管/管理。如果您还没有 Azure 订阅，请在此处尝试获取试用版：注册 Azure 试用版。

创建 API 管理实例

首先，我们需要创建一个 API 管理实例。请按照以下步骤操作：

从此链接登录到您的 Azure 管理门户：https://manage.windowsazure.com。
如果您没有订阅，请在此处获取一个：http://azure.microsoft.com/en-us/pricing/free-trial。
单击“新建”，然后单击“应用服务”，再单击“API 管理”，最后单击“创建”。
现在，在“新建 API 管理服务”下
在“URL”文本框中，指定一个唯一的子域名以用于服务 URL。
为您的服务实例选择所需的订阅和区域。做出选择后，单击“下一步”按钮。
输入组织名称和电子邮件 ID
API 管理服务实例有：开发人员、标准版和高级版。默认情况下，新的 API 管理服务实例将使用开发人员层创建。要选择标准版或高级版，请选中“高级设置”复选框，然后在下一个屏幕上选择所需的层。
```
(P.S.: Premium is not available in promotional and Free/Trial accounts).
```
最后，单击“创建”。
在这里，我们进入了 API MANAGEMENT 屏幕。
单击仪表板底部的“管理”，我们将进入
要创建我们的第一个 API，请单击左侧 API 管理菜单中的“API”，然后单击“添加 API”。
让我们回顾一下我们之前所做的工作。
- 我们在“Web API 标题”文本框中为我们的 API 指定了一个唯一的名称，即“Demo”。Web API 标题为 API 提供了一个独特且描述性的名称。它会显示在开发人员和管理门户中。
- 我们在“Web 服务 URL”中提供了我们的 WEB API 托管的实际地址，请参阅上面的部分，其中我们讨论了将 WEB API 部署到 Azure。http://crudwithwebapi.azurewebsites.net/。Web 服务 URL 引用实现 API 的 HTTP 服务。API 管理会将请求转发到此地址。
- 我们为 API 提供了“demo”作为后缀。Web API URL 后缀将附加到 API 管理服务的基本 URL。我们的 API 将共享一个通用的基本 URL，并通过附加在基本 URL 后面的唯一后缀进行区分。
- Web API URL 方案决定了可用于访问 API 的协议。默认指定 HTTPS。
```
(P.S.: Here we selected both HTTP and HTTPs protocols – will discuss about this 
in coming sections/series of articles)
```
API 部分有六个选项卡。
- “摘要”选项卡显示有关 API 的基本指标和信息。
- “设置”选项卡用于查看和编辑 API 的配置，包括后端服务的身份验证凭据。
- “操作”选项卡用于管理 API。
- “安全”选项卡可用于使用 Basic 和 Mutual 证书设置代理身份验证，或用于设置 OAuth 2.0 – 我们将不详细讨论这一点。
- “问题”选项卡可用于查看开发人员在使用我们 API 时报告的问题。
- “产品”可用于创建和管理我们 API 的产品——在本文中，我们将不讨论此部分。

添加操作

请按照以下步骤操作：

转到“操作”选项卡。
我们还没有创建任何内容，所以这个选项卡是空的。
单击“添加操作”以添加新的 API 操作。

在我们的 Web APIs 中，我们有以下资源：

操作	HTTP 方法	相对 URI
获取 serverdata 列表	`GET`	/api/serverdata
按 ID 获取 serverdata	`GET`	/api/serverdata/id
按数据类型获取 serverdata	`GET`	/api/serverdata/type/datatype
按机器 IP 获取 serverdata	`GET`	/api/serverdata/ip/ip
创建新的 serverdata	`POST`	/api/serverdata
更新现有的 serverdata	`PUT`	/api/serverdata/id
删除现有的 serverdata	`删除`	/api/serverdata/id

让我们将第一个 API 资源作为操作添加到 API 管理门户。

在前面的部分，我们指定了：
- HTTP 动词为 GET – 用于检索内容。
- URL 模板 – 我们的 Web API 的实际资源（如上表所述）。
- 对于此操作，我们没有请求参数，因此无需定义任何参数。
- 请注意，我们可以将参数作为查询参数或请求正文。
- 在“响应”下，我们选择 HTTP 状态代码 200，即“OK”，表示一切正常时，它将以指定的 application/json 格式返回。
我们已完成 API 的工作。我们已将 Web API 与 Azure API 管理一起托管。现在，它们已准备好供开发人员使用或消费。开发人员将使用 Azure API 管理开发人员门户来使用/查看所有 API 相关的文档。

不幸的是，我们还没有注册任何用户作为开发人员，让我们按照以下步骤注册我们的 API 产品。
```
(P.S.: we will discuss in coming session – how to setup different products 
and mange users with Azure API Management).
```

获取已创建 API 产品的订阅

要创建订阅者，我们可以通过邀请和使用 API 管理的管理门户来完成。

在此，我们使用的是开发人员门户，我们已经向我们的最终用户或目标受众发送了开发门户链接。

讨论 API MANAGEMENT 开发人员门户

在本节中，我们将简要介绍开发人员门户。

这将是每个开发人员的默认主页。开发人员可以查看 API 文档、您的 API 博客（如果已创建）以及其他应用程序（如果您为任何产品提供）。

由于我们不深入探讨开发人员门户的细节，让我们注册为订阅者。

单击右上角的“登录”。
在登录页面（由于我们尚未注册），单击“立即注册”。
输入所有指定信息，然后单击“注册”。
您需要验证您的电子邮件
验证您的电子邮件后，登录开发人员门户，单击“API”链接。
订阅产品。
在管理员门户中，单击“用户”并批准用户的订阅。
- 在开发人员门户中，单击“Demo API”。
- 在这里，您将看到“Demo”下列出的所有 API。
- 单击“First Get ServerData”。
- 在这里，您可以看到我们的请求 URL 需要一个订阅密钥，这只是 Azure API MANAGEMENT 根据订阅提供的我们的主/次 API 密钥。