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 文件及其相关性的 zip 文件的 URL。
4. “根文件名”字段中,输入要获取的 RAML 根文件的名称。
5. 单击“获取”以获取在 RAML 文件中定义的所有 API。
“API 请求”列表提供了在 RAML 文件中定义的 API 列表。
6. “API 请求”列表中,选择一个 API。
根据所选 API 的不同,您可能还必须提供其他详细信息。
7. 单击“完成”
输出架构
这对您有帮助吗?