RAML
RAML - (RESTful API Modeling Language 即RESTful API建模語言)
- 易於閱讀API
- 易於設計API
- 易於共享API
- 語法簡潔明瞭
- 關注需要定義的信息即可
- 機器可解析並生成html文檔
開發工具
- API Designer
- API Console`
- API Notebook`
摘要
RAML 是一種基於HTTP-API的定義語言. 體現了所有對象傳輸狀態的原則 . RAML基於YAML ,符合1.2版本規範,能幫助設計 RESTful API 和鼓勵 API的發掘和重用 , 依靠標準和最佳實踐從而編寫更高質量的API . 生成全面的用戶文檔 .
RAML通過一個格式來提供規範的接口.作爲API提供者和使用者之間的合約.用戶可使用文檔實現客戶端和服務器的交互.
組織結構
- 基本信息 解釋瞭如何描述核心API的方面,如它的名稱、標題、位置(URI)和違約。描述如何包含API的支持文檔。
- 數據類型 描述了一種通過簡化模型API數據類型系統,也包括JSON和XML模式。
- 資源 描述瞭如何指定一個API的資源和嵌套的資源,以及在任何URI URI參數模板。
- 方法 描述瞭如何指定API的資源上的方法,以及他們的請求頭,查詢參數和請求。
- 響應 描述API規範的反應,包括狀態碼、媒體類型,響應頭和響應。
- 資源類型和特徵 描述可選機制使用RAML資源類型和特徵描述資源,避免不必要的重複在一個API的定義和促進一致性和重用。
- 安全 描述了機制中可用RAML指定一個API的安全方案。
- 註釋 描述了擴展機制RAML規範通過定義強類型的註釋和應用規範。
- Includes,Libraries 覆蓋以及擴展 描述了一個API的定義可能是由外部化定義文件,如何打包成庫集合的定義,如何分離和覆蓋層的元數據的RAML文檔,以及一個API規範與附加功能可以擴展。
連接 : RAML官方解釋
目錄
用 [TOC]來生成目錄：