问题标签 [raml]

我目前正在尝试生成我的 API，但在为列表组中的第一个方法添加描述时遇到了一些困难。我可以为组中的所有其他方法添加描述，而不是第一个。

我在下面附上了一张我希望它看起来如何的图片，但我无法使用 RAMLtoHTML 生成器来实现这一点。

下面是我在主文件中使用的代码。该文件包含我遇到问题的文件。我在想也许我可以改变它？

这是我要在下面添加描述的文件。正如你所看到的，我已经添加了一个列表描述，如果我尝试在这里添加一个方法描述，那么我会从解析器那里得到一个“描述”已经定义的抱怨。

有没有人有解决方法？我尝试在包含之前的第一个文件中添加描述，但得到解析器错误。我也尝试在第二个文件中移动 /hubs 声明，但我可以让它解析的唯一方法是在方法调用 URL 中添加一个额外的字符，这远非理想。

我是 RAML 的新手，我有一个基本问题：

无法指定一组替代 baseUri（只允许一个）。是否有任何替代方法来模拟 API 的多个替代安装（例如，用于单独的发布周期环境）？

我正在准备一个 ReSTful 服务，我想用 RAML（也许还有 Swagger）来记录它，但似乎我不能同时在同一个应用程序中实现 JAX-RS 和 RAML。

我为 JAX-RS 创建了一个 Application 类，如下所示：

我按如下方式附加 JAX-RS 应用程序对象：

而且我还想实现 RAML 扩展，但它看起来像绑定到 Restlet 路由器并拥有它自己的应用程序类。有没有办法将两者结合起来？

我正在尝试在我的 RAML 中对具有任意 URL 参数列表的 GET 请求进行建模。2 个参数是已知的，但其余的是从其他请求类型的响应数据中选择的名称/值对。我尝试在我的 queryParameters 列表中使用 additionalParameters: true ，但是当它尝试解析 RAML 时，我从 osprey-mock-service 收到一条错误消息：

我的 RAML 中的相关片段是：

当我删除该行时，错误消息消失：

我还没有找到表明您可以将 AdditionalParameters 与 queryParameters 一起使用的参考资料，但您可以这样做似乎是有道理的。

我不一定需要解决错误消息，但我希望有如下 URL 参数：

其中 content 和 node 不是预定义的参数名称。

这可能吗？

我对 Web API 描述语言的世界还很陌生，并且刚刚开始为我们的 JAX-RS 应用程序研究 Swagger、API 蓝图和 RAML。它们看起来都很棒，但我有一个问题。

我的理解是自上而下的方法，你首先设计你的 API，生成一个漂亮的 HTML 文档，可能还有一个模拟，然后开始编码。

但是，如果在实施过程中由于某些原因最终不得不更改 API 的签名，例如更改响应主体模型，该怎么办？我的意思是在这种情况下，您的 API 规范需要更改，并且您必须手动编辑您的 API 规范以使其与您的代码保持同步，因为似乎没有成熟的库可以从源代码生成 API 规范。（我已经为 Swagger 和 RAML 测试了此类库，但没有测试 APIB，因为我找不到 JAX-RS 源 APIB 转换库。）在上述情况下，您如何处理它？

您是手动编辑 API Spec 还是使用某些库自动进行编辑？如果是后者，你能告诉我图书馆的名字吗？

我对在我的 json 模式中定义属性的哪种情况感到困惑。

假设我有一个product我正在尝试为其定义模式的项目。在我的数据库中，该表products具有id、brand_id、和。除必填字段外的所有字段。由数据库自动生成，并在创建时由 api 根据用户创建自动设置。nameitem_numberdescriptiondescriptionidbrand_id

这意味着我只能POST /api/products使用以下数据：

但是，我现在应该如何定义产品架构？我应该包括属性id和brand_id？如果是这样，我是否应该根据需要标记它们，即使它们是自动设置的？

这就是我想出的：

错误信息：

代码：

问题是有时值不止一个来自选择查询，我该如何过滤。我可以通过 WHERE ROWNUM = 1 过滤查询来做到这一点，但是如何在 Mule 中处理而不是在查询中处理呢？

我正在使用RAML来记录我的 REST API。在 RAML 文档中，我在根级别指定了基本 URL

然后在文档的 API 端点部分，我指定它们相对于这个基础的 URL，例如

当我运行raml2html从 RAML 文档生成 HTML 页面时，相对 URL/foo/bar显示在 API 端点的文档中，但我更愿意显示绝对 URL http://api.example.org/api/v1/foo/bar，这可能吗？

我正在用 mule + raml + counchDB 实现一个 Web 应用程序。它工作得很好。但现在我必须开发一个身份验证功能。不仅要验证 api 客户端，还要验证该客户端的用户。目标是达到与普通 Web 应用程序相同的行为。用户调用 url，加载登录页面，用户输入用户名和密码并进行身份验证。之后，对于每个请求，我必须验证用户登录和 url 参数，以确保他有权访问信息。

但是我迷失了最好的方法是如何做到这一点，或者即使骡子也可以。我已经阅读了有关 HTTP 基本身份验证的信息，我认为这符合我的需要。但我不知道是否允许我验证 muof 用户并管理它以执行正确的验证。

感谢关注，瓦尔特·戈麦斯

我有一个使用 Restlet 2.3.1 (JSE) 的项目。我们根据 Restlet 网站使用 maven：

这一切都很好，但是当我尝试添加 RAML 扩展时：

我收到以下错误：