问题标签 [raml]

我想在 Eclipse 上编辑 RAML。我没有找到 RAML 的任何 Eclipse 插件。

在 RAML 网站 ( http://raml.org/projects.html ) 上只有 Sublime。

您知道在 Eclipse 上编写 RAML 的丰富经验的选项吗？

我正在寻找一种有效的方法来从 Cloud Endpoint (Java) 生成的文件中生成可读格式的 API 文档。生成的文件是： - my_api.api - my_api*.discovery

看起来像这样的东西： - https://github.com/kevinrenskers/raml2html#example-output

Swagger、API blueprint 和 RAML 都是不错的选择，但似乎不能很好地适应端点生成的 API 描述符文件。

你使用什么方法？

我正在尝试使用 RAML 来具体描述各种加密货币交换 API ，它们都使用不同的格式（非标准化）来呈现和记录其 API。我很容易为 RESTful API 执行此操作（因为据我了解，这主要是 RAML 的用途），但对于使用 JSON-RPC over https 的 API 执行此操作却很困难。

首先...这可能和/或可行吗？

如果可能和/或可行，以下是正确的方法吗？这似乎是有限的，因为我不知道枚举可能的方法及其各自参数的方法，我只能声明有一个方法参数。

正如 David Dossot 所建议的那样，我尝试使用 JSON 模式而不是 queryParameters。这是我的尝试（我仍然没有看到枚举/描述 API 的各个方法的方法，我只能表示有一个方法关键字并且它是一个字符串（类似于我对查询参数路由）。

现在我正在使用模式，但我仍然看不到可以枚举或描述 API 的各个方法的方法。

2014 年 8 月 13 日更新：

尝试使用 JSON $refs 和子模式（仍然遇到如何将方法与其关联参数链接以及如何描述方法等问题，因为 JSON Schema v4 只有 3 个字符串验证参数（类型该方法在 JSON-RPC 中，它不是对象）、maxLength、minLength 和模式。没有足够的表达力来解释该方法是/做什么以及它的选项/可用参数）

我在RAML中声明了一个 REST 服务 API 存根。我的web应用提供了设备，可以列出，可以通过id或者code获取。当我想要整个列表时，我不指定任何 URI 参数，但是为了获得具体的设备，我会这样做。这是它的当前状态：

在这里，description我在字段中写下当前调用的执行情况。但是，我想为 URI 本身（id或code）中传递的参数添加说明。有没有办法实现它？

我是 mule-AnyPoint Studio 的新手。使用 RAML 在 java 中使用 mule-AnyPoint Studio 进行 api 集成是否必不可少。

过去几天我一直在试图了解是否应该使用 api blueprint、RAML 或 swagger。

看起来 swagger 拥有最大的社区，但我越看越觉得它在文档方面非常缺乏（我被迫多次查看代码以尝试将其与我当前的项目集成），许多 github 问题和 stackoverflow问题没有答案。

我有可能在这里遗漏了什么吗？我想要的只是一个工具来帮助我编写 API 文档和测试端点。

为什么大摇大摆必须成为服务器逻辑的一部分？如果我在编辑器中创建 swagger 文件，然后直接将它们提供给UI，它会中断..

据我所知，它甚至使服务器稍微慢了一点，并迫使存在许多笨拙地维护的集成：p 我在这里错过了什么？

我想这个问题是不言自明的。我有一个名为的查询参数expand，如果提供该参数，它将提供相关资源的嵌入式表示。否则，它会提供指向所述资源的链接。有没有办法根据expandRAML 中的值提供这两个示例？

有没有办法让 API Kit 路由器验证传入的模式？我的 RAML 文件中有以下内容，但它不验证传入的架构。

我有一个基于 RAML 的 Mule Flow，它执行一个返回 180 左右行的 sql 查询。我在我的 yaml.xml 中定义了特征分页。但是当我运行流程似乎返回所有行。下面一次不是 10 行，而是我的 yaml 的一个片段。我是否还需要在后端实现分页

谢谢。

问题：

我正在搜索 Java 或 JavaScript（或者可能是 Scala）中的库，它能够生成 Swagger、RAML 或 API 蓝图输入的 HTML 表示。

背景：

这个想法是将其用作（Play Framework）网络应用程序的一部分，用作 API 目录。API 规范将由 API 目录的用户添加，并生成/显示生成的 HTML 表示。

如果 API 规范存根也可以使用 Java API 创建，这将提供额外的价值。API 目录 Web 应用程序有一个数据模型，我想在生成 API 存根时使用它。

此外，如果同一个（或相关的另一个）库提供了一个很好的 API 规范语言（Swagger、RAML、API 蓝图等）的 HTML 编辑器，在编辑时支持用户，它将提供额外的价值。