之前筆者在 RAML - RESTful API Modeling Language - Level Up 這篇介紹過的 RAML，近期推出了 RAML Tools for .NET，是一 Visual Studio 的擴充套件，可輔助我們用 RAML 開發 Client 與 Server 端的程式。 使用前需先透過 Extensions and Updates 功能安裝 RAML Tools for .NET 這擴充套件。 {% img /images/posts/GenerateClientFromRAML/1.png %} 安裝完後要輔助開發 Server 端的 Web API 程式的話，我們只要開啟 Web API 專案，透過方案總管在專案的 Reference 上按下滑鼠右鍵，選取 Add RAML Contract... 這個選單選項。 {% img /images/posts/GenerateWebAPIFromRAML/1.png %} Add RAML Contract 視窗即會跳出，這邊可為該 Web API 創建個新的 RAML contract，或是透過網址及檔案的方式來指定已存在的 RAML 檔案。 {% img /images/posts/GenerateWebAPIFromRAML/2.

之前筆者在 RAML - RESTful API Modeling Language - Level Up 這篇介紹過的 RAML，近期推出了 RAML Tools for .NET，是一 Visual Studio 的擴充套件，可輔助我們用 RAML 開發 Client 與 Server 端的程式。 使用前需先透過 Extensions and Updates 功能安裝 RAML Tools for .NET 這擴充套件。 {% img /images/posts/GenerateClientFromRAML/1.png %} 安裝完後要輔助開發 Client 端程式的話，我們只要透過方案總管在專案的 Reference 上按下滑鼠右鍵，選取 Add RAML Reference... 選單選項。 {% img /images/posts/GenerateClientFromRAML/2.png %} Add RAML Reference 視窗即會跳出，這邊可透過網址或是檔案的方式來指定 RAML 檔案。 {% img /images/posts/GenerateClientFromRAML/3.png %} 這邊筆者用 Twitter 的 RAML 來做個示範，複製其 RAML 的網址。 {% img /images/posts/GenerateClientFromRAML/4.

RAML (RESTful API Modeling Language) 是ㄧ以YAML為基礎、專門用來描述 RESTful API、且人與機器都看得懂的標記語言。 {% img /images/posts/RAML/1.png %} 因為透過RAML去描述的API，機器也能夠看得懂，所以可以衍生出一些附加的功能服務，像是解析並自動產生對應的 API Console、API Client、API Server、API User Document…等。 Root Section RAML文檔最開始是Root Section，是用來做 API 基本的描述用，像是 API 的標題、API 版本、API 基底位置、相關文檔、與 schema 及其參考…等。 就像下面這樣： #%RAML 0.8 --- title: GitHub API baseUri: http://api.github.com/{version} version: v1 一開始要描述RAML的版本，接著就是帶入 API 的標題等。以這例子來說，這邊是在描述 GitHub 的 API ，API 的基底位置是 http://api.github.com/{version} ，基底位置內寫的 {version} 會被實際的版本取代，而目前的版本是 v1 。 除了上面範例提到的設定外，還有其它可用的設定，這邊不深究，請直接參閱下表整理： Resource Root Section設定好我們已經有 API 的基底位置了，所有的 API 都是以這基底下去延伸，我們可能為了讓 API 更為清楚，而在 API 基底位置下再加上幾層 Resource 進去，像是 GitHub API 的 API 基底位置是 https://api.