RAML
「RESTful API 建模語言」(RAML) 是一種描述 RESTful API 的 YAML 式語言。RAML 也提供一些功能,能夠廣泛記錄 RESTful API、讓文件集產生器工具能夠擷取使用者文件集,然後再將其轉換為例如 PDF、HTML 等視覺格式。
使用 RAML 動作可存取 API,並對使用 RAML 為其建構 API 的服務進行 API 呼叫。RAML 動作支援 RAML 規格版本 0.8。
完成下列步驟,可在工作流程中使用 RAML 動作:
1. 按一下 ,將「API 設計」下所列的 RAML 動作拖曳到畫布上,將指標置於動作上,然後按一下 或連按兩下該動作。RAML 視窗即會開啟。
2. 視需要編輯「標籤」。依預設,標籤名稱與動作名稱相同。
3. 「根檔案 URL」欄位中,輸入用來擷取包含根 RAML 檔案及其相依性之壓縮檔的 URL。
4. 「根檔案名稱」欄位中,輸入您要擷取之 RAML 根檔案的名稱。
5. 按一下「擷取」以擷取在 RAML 檔案中定義的所有 API。
「API 請求」清單提供在 RAML 檔案中定義之 API 的清單。
6. 「API 請求」清單中,選取 API。
根據您選取的 API 而定,您可能必須提供其他詳細資訊。
7. 按一下「完成」
輸出結構描述
這是否有幫助?