Mulesoft中的Raml 1.0簡介

banq發表於2022-02-09

RAML : Restful API 建模語言。RAML 的最新版本是 1.0。

為什麼需要編寫 RAML？

  1. RAML 是瞭解作為開發人員如何實現 Mule 應用程式的第一步。它有助於從 API 消費者那裡獲得反饋，例如他期望的響應是什麼，他如何將請求傳送到 API。
  2. 它作為一個框架來理解 API 可以做什麼或提供什麼。例如，通過在公共門戶中檢視 Rest API 的概述，API 使用者可以瞭解他可以獲取電影資訊、預訂票和取消票等。
  3. 它在請求到達 API 實現之前驗證傳入的 http 請求。
  4. 它有助於在 API Manager 中對 API 應用不同的策略。

現在讓我們看一下 RAML 的基本用例。

請從git repo獲取以下程式碼

https://github.com/vijayakumarvaka/RAML.git

我們有一個主要資源，即“bookmyshow”和兩個子資源，即電影和門票。

所有資源都以斜槓 (/) 開頭。

/movies:

GET方法。它將幫助你檢索請求URI中定義的資訊。

description：將幫助你提供http方法將做什麼的資訊。

因為我們是為獲取請求而獲取資訊，所以你不需要在請求中傳遞任何主體。

響應。你可以在response下有n個響應。請以200響應為例，它是GET請求的預設成功狀態程式碼（200）。

 

/tickets:

釋出方法。這種方法幫助你在後臺系統中建立一個新條目。

這是一個POST方法，所以你必須在你的http/https請求中傳送body。

 

相關文章