Visual Studio 2013中的 Azure API 应用程序

  • Article

[原文发表地址]: Introducing the Azure API Apps Tools for Visual Studio 2013

[原文发表时间]: 24 Mar 2015 12:00 AM

伴随着Azure SDK 2.5.1的发布，我们借此机会把现有的网页发布技术和新的Azure Resource Management APIs结合来支持对于网络，移动端和API 开发者Azure App Service的最新功能。我们已经添加了Azure API 应用程序作为面向ASP.NET开发人员的发布目标，因此可以使用Visual Studio里的新Azure门户中像资源组，应用程序托管计划等这些概念。

使开发者能一键式强类型REST API 客户端

对于那些需要不断地使用从不同的供应商或者服务获得的REST APIs的开发者，一个Azure 应用程序服务的组件 - Azure API Apps – 公开元数据格式像Swagger和WADL来描述REST API 终止点。Included是一个新的Azure API应用程序模板，它从ASP.NET Web API 控制器提供dynamic Swagger generation. 另外，在Visual Studio中还有一个新的功耗系统提供one-click C# code generation 功能使得比以前更容易的使用REST API 而无需重写HTTP调用或者JSON，XML解析。在Portable Class Library项目中也支持生成的客户端代码，这样你就可以在任何支持PCL的平台使用，像Windows Phone 8.1和Universal apps应用程序，以及针对Android和带有Xamarin的IOS这些书面定位的应用程序编写。阅读更多关于Azure 应用程序服务在Micorsoft 博客announcing the availability of Azure App Services 和 Azure 博客 announcing Azure App Service. 你还可以查看 recording of the webcast announcement 了解更多。

进入一个丰富的第三方APIs市场

现在Azure Marketplace 包含许多现有的Microsoft服务和产品，包含其他的合作伙伴的APIs,像Twilio, Salesforce, and Dropbox. REST API功耗功能定制化通过Azure 管理门户的界面对于APIs 安装也是可用的。那么你就能够在迅速成长的Azure上访问强类型客户端的任何APIs.

点对点的开发，部署和使用Azure的API应用程序的经验

现在让我们来演示新的Azure API应用程序工具。开始，我们将在2.5.1发布版本的使用新项目模板创建一个新的Azure API应用程序。然后，部署Azure API应用程序到云。一旦部署了它，我们将创建一个简单的客户端应用程序，它将通过强类型自动生成的客户端代码来使用之前部署的 API 应用程序.

入门教程：Azure API应用程序模板

使用Visual Studio 2013 创建一个新的命名为TodoListApi的网站应用程序

当一个One ASP.NET对话框打开时，选择Azure API Apps template. Azure API应用程序模板是网页API 项目的一个梗概，包含Azure API 应用程序 SDK NuGet和Swashbuckle NuGet 程序包，为dynamic Swagger generation提供支持。

 

注意API应用程序模板的项目自述文件。它包括一些很有用的归档文章的链接，这些文章将更详细地描述如何编写，部署，调试和使用Azure API应用程序。

使用这种模式添加一个自定义模型和控制器。下面的截图演示了添加一个TodoItem 模型和TodoController类后的醒目的结构。

接下来通过使用 右击>为web工程发布特性 来在您的Azure 订阅中创建一个新的Azure API。

选择新的Microsoft Azure API Apps (Preview) publish target.

Azure API应用程序对话框将会打开。在Azure 订阅中单击新建按钮来创建一个新Azure API应用程序。

Azure API 应用程序新建对话框将打开。现在，选择一个现有的 App Service Plan和Resource Group, 你的API应用程序将被部署。这个演示的目的，在对话框中使用方便的选项来创建一个新App Service Plan and Resource Group。

一旦你点击OK，Azure API 应用程序资源调配便开始了。这个过程将花费1-2分钟，你将收到一个警告，资源调配的进程将要完成。一旦它完成，再次执行发布动作将你的代码发布到API应用程序实例。

Azure 应用程序服务活动窗口将会反映出在您的订阅中创建的新Azure API应用程序的过程。创建进程完成后，会通知您。

一旦创建进程完成，在API应用程序项目执行右击>Publish 动作，观察发布设置文件是常驻的，代码准备发布到Azure。

注：你必须执行两次发布的流程来确保你的代码被发布到新设置的站点。第一个发布流程在您的订阅中创建Azure API 应用程序资源但是创建完成并不发布代码，因此您需要执行第二次发布来布署您的代码。

一旦你点击了Publish 按钮，API的应用程序代码将被布署到您正在运行的Azure API应用程序实例中。

在Azure 管理门户中查看Azure API 的应用程序定义

布署完成后，您可以在您的网页浏览器中开启Azure 管理门户，导航到您刚刚布署的API应用程序。通过在门户页上点击API定义按钮的API应用程序，你将看到你的网页API TodoController的REST API 端点和默认ValuesController（除非你从项目中删除ValuesController.cs 文件）。

在Visual Studio中的一键式API 应用程序客户端代码生成

API应用程序使用适用于大多数的C# 项目类型，在将来的发布中会添加更多。这个演示的目的，我们只是把一个简单的控制台程序来调用Azure API应用程序来验证它可以使用。作为使用API的开始，我们在Visual Studio中添加一个新的项目到您的解决方案中。

下一步，从对话框中的项目模板中选择Console Application，命名项目TodoListApiClient.

一旦在Visual Studio中加载了项目。右击项目节点并在上下文菜单选择Add > Azure API App Client 条目来打开Azure API 应用程序客户端生成对话框。一旦它打开了，选择Download from Microsoft Azure API App标签的按钮，选择您刚刚发布到Azure的TodoListApi API应用程序。然后，点击OK按钮。注意，如果喜欢你还可以为API应用程序客户端代码代码提供一个自定义命名空间。但是默认的命名空间等于您的控制台应用程序项目的基命名空间。

一旦您单击OK按钮，Visual Studio将从您的Azure API应用程序去掉Swagger元数据并且生成客户端代码使得您的控制台程序更易于调用您的Azure API应用程序端点。一旦Azure API应用程序客户端代码生成，你将看到已经添加到了控制台应用程序项目。

现在，在控制台应用程序项目中打开Program.cs文件。生成的代码比以前更易于使用强类型类和方法来调用您的Azure API 端点。下面的代码将伸向API和调用其Get方法，从API中返回TodoItems 的列表。

一旦你在Visual Studio调试器中按下F5去启动控制台应用程序，它将调用在云中运行的Azure API，拆掉TodoItems的列表，并将它们显示在控制台窗口中。

从来没有比通过现在的REST APIs去开发，布署，使用数据更容易的了。Download the Azure SDK for Visual Studio来尝试这个Azure API应用程序的新工具。

取得联系

社区反馈对Visual Studio 工具扩展的成功是势在必行的趋势，我们很重视您的反馈意见。欢迎您通过Visual Studio内的Send-a-Smile and Send-a-Frown 界面反馈意见，或者您可以通过Visual Studio Connect site填写一个bug. 如果您对我们刚刚介绍的产品就如何加强Azure API应用程序的工具功能有任何的想法，请在Visual Studio UserVoice或ASP.NET UserVoice分享它们。Azure API应用程序资源和工具在2.5.1发布版本的预览。在预览版期间我们很欢迎您的反馈意见和更多的需要。此外，请查看Azure SDK for .NET Release Notes的完整功能列表和已知问题。