RAML : Restful API 建模语言。RAML 的最新版本是 1.0。
为什么需要编写 RAML?
- RAML 是了解作为开发人员如何实现 Mule 应用程序的第一步。它有助于从 API 消费者那里获得反馈,例如他期望的响应是什么,他如何将请求发送到 API。
- 它作为一个框架来理解 API 可以做什么或提供什么。例如,通过在公共门户中查看 Rest API 的概述,API 使用者可以了解他可以获取电影信息、预订票和取消票等。
- 它在请求到达 API 实现之前验证传入的 http 请求。
- 它有助于在 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。