本文是系列教程的第一篇,介紹如何使用 Azure 應用服務中有助於開發和托管 RESTful API 的功能。本教程介紹 Swagger 格式 API 元數據的支持。 學習內容: 如何通過 Visual Studio 2015 中的內置工具在 Azure 應用服務中創建和部署 API 應用。 如何使 ...
本文是系列教程的第一篇,介紹如何使用 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”或更高版本。
-
下載示例應用程式及後續操作,感興趣的朋友可以點擊這裡繼續閱讀。