本文是系列教程的第一篇,介绍如何使用 Azure 应用服务中有助于开发和托管 RESTful API 的功能。本教程介绍 Swagger 格式 API 元数据的支持。
学习内容:
- 如何通过 Visual Studio 2015 中的内置工具在 Azure 应用服务中创建和部署 API 应用。
- 如何使用 Swashbuckle NuGet 包动态生成 Swagger API 元数据,以便自动进行 API 发现。
- 如何使用 Swagger API 元数据自动生成 API 应用的客户端代码。
示例应用程序概述
本教程使用简单的待办事项列表示例应用程序。该应用程序包含单页应用程序 (SPA) 前端、ASP.NET Web API 中间层和 ASP.NET Web API 数据层。
下面是 AngularJS 前端的屏幕截图。
Visual Studio 解决方案包含三个项目:
- ToDoListAngular - 前端:用于调用中间层的 AngularJS SPA。
-
ToDoListAPI - 中间层:调用数据层,对待办事项执行 CRUD 操作的 ASP.NET Web API 项目。
-
ToDoListDataAPI - 数据层:对待办事项执行 CRUD 操作的 ASP.NET Web API 项目。
三层体系结构是可以使用 API 应用实现的多种体系结构之一,此处仅用它来进行演示。每一层中的代码尽可能以最简单的方式来演示 API 应用功能;例如,数据层使用服务器内存而不是数据库作为持久性机制。
完成本教程后,将创建两个在云中应用服务 API 应用中启动并运行的 Web API 项目。
本系列教程的下一篇文章会将 SPA 前端部署到云中。
先决条件
-
ASP.NET Web API - 本教程中的说明假设读者基本了解如何在 Visual Studio 中使用 ASP.NET Web API 2。
-
Azure 帐户 - 可以打开 Azure 帐户。
-
Visual Studio 2015 和用于 .NET 的 Azure SDK - SDK 会自动安装 Visual Studio 2015(如果尚未安装)。
-
在 Visual Studio 中,单击“帮助”->“关于 Microsoft Visual Studio”,确保安装了“Azure App Service Tools v2.9.1”或更高版本。
-
下载示例应用程序及后续操作,感兴趣的朋友可以点击这里继续阅读。