使用Azure API管理服务管理Web API

在本文中,将探讨如何使用Azure管理服务来管理Web API。这里,将专注于使用Azure管理来管理Web API,而不是讨论Azure管理的工作原理、如何创建虚拟机、创建云应用以及如何使用Azure托管应用。

本文将涵盖以下内容:

  • 创建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的信息,请参考以下文章:

将服务托管/部署Azure

希望已经阅读了上述步骤中提到的文章。现在,如果还没有下载演示项目,请下载它。否则,可以在这里找到完整的源代码:

现在,让将上述创建的服务部署到Azure服务器上。

从解决方案资源管理器中,右键单击并发布。

// 从解决方案资源管理器中,右键单击并发布 Publish

将ASP.NETWeb API作为Azure网站进行部署/发布,因此可以获取一个健壮的端点——将在接下来的会议/文章中讨论这个问题。然后,点击发布。

几分钟后,Web API将可用。

通过浏览URL进行检查:

让继续设置Azure API管理。

使用Azure管理

现在,已经准备好使用Azure管理来托管/管理Web API。如果没有Azure订阅,请尝试从这里获取试用版:

首先,需要创建一个API管理实例。请按照以下步骤操作:

  1. 从这里登录到Azure管理门户:
  2. 如果没有订阅,请从这里获取:
  3. 点击“新建”,“应用服务”,“API管理”,“创建”
  4. 现在从“新建API管理服务”:
  5. 在URL文本框中,指定要用于服务URL的唯一子域名。
  6. 选择服务实例所需的订阅和区域。选择后,点击“下一步”按钮。
  7. 输入组织名称和电子邮件ID
  8. API管理服务实例有:开发人员、标准和高级。默认情况下,新的API管理服务实例使用开发人员层创建。要选择标准或高级层,请选中高级设置复选框,并在以下屏幕上选择所需的层。(注:促销和免费/试用帐户中不可用高级)
  9. 最后,点击创建。

在这里,在API管理屏幕上。

点击仪表板底部的“管理”,将进入:

要创建第一个API,请单击API管理菜单左侧的“API”,然后单击“添加API”。

按照以下步骤操作:

  1. 转到操作标签。
  2. 没有创建任何内容,所以这个标签将是空的。
  3. 单击“添加操作”以添加新的API操作。

Web API中,有以下资源:

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

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

在前面的部分中,指定:

  • HTTP动词为GET——用于检索。
  • URL模板——Web API的实际资源(如上表所述)。
  • 对于此操作,没有任何请求参数,因此不需要定义任何参数。
  • 请注意,可以将参数作为查询参数或正文提供。
  • 在响应下,选择HTTP状态码200,即“OK”,意味着当一切正常时,它将返回指定的application/json格式。

已经完成了API的工作。已经使用Azure API管理将Web API托管。现在,这些已经准备好使用或由开发人员使用。开发人员将使用Azure API管理开发人员门户来使用/查看所有API相关文档。

不幸的是,还没有注册任何用户作为开发人员,让按照以下步骤注册API产品。

(注:将在接下来的会议中讨论——如何设置不同的产品和管理用户与AzureAPI管理)。

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

在这里,使用开发人员门户,已经邀请/共享了发展门户链接给最终用户或目标受众进行开发。

在本节中,将简要讨论开发人员门户。

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

由于不会详细介绍开发人员门户,让注册为订阅者。

  1. 点击右上角的“登录”。
  2. 从登录页面(因为还没有注册),点击“立即注册”。
  3. 输入所有指定的详细信息,然后点击“注册”。
  4. 需要验证电子邮件:
  5. 在电子邮件验证后,登录到开发人员门户,点击API链接。
  6. 订阅一个产品。
  7. 从管理员门户,点击用户并批准用户的订阅。
  8. 点击开发人员门户中的Demo API。
  9. 在这里,将获得Demo下的所有API列表。
  10. 点击第一个获取ServerData。
  11. 在这里,可以看到请求URL需要一个订阅密钥,这只是一个主/辅助API密钥,由Azure API管理根据订阅提供。

可以通过任何外部客户端或使用API开发人员门户内的控制台来测试托管的API。

  1. 点击当前获取ServerData API的“打开控制台”。
  2. 在这里,需要API密钥,选择主密钥或辅助密钥。
  3. 在点击HTTPGET(这是一个GET资源)后,将获得相关输出。

已经完成了所有工作,使用AzureAPI管理来管理Web API。

沪ICP备2024098111号-1
上海秋旦网络科技中心:上海市奉贤区金大公路8218号1幢 联系电话:17898875485