问题标签 [raml]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
2732 浏览

json - 在 RAML 中使用外部模式

我有一个 RAML 规范,我想在不同文件夹中的其他项目中引用 JSON 模式。

我怎么做?

我只能发现您可以通过这样的 url 引用架构:

潜在的解决方案

0 投票
2 回答
196 浏览

api - RAML 默认信封

我的 API 对所有集合类型资源都有一个默认信封,如下所示:

是否可以使用 RAML 来定义它?在资源类型中?如何?

0 投票
3 回答
3185 浏览

node.js - 是否有 Raml 1.0(不是 0.8)HTML 生成器?

有人知道是否有 raml2html 到 Raml 1.0 的版本?我只找到了适用于 Raml 0.8 的工具,例如raml2htmlraml2md,但不适用于 Raml 1.0。

0 投票
1 回答
1263 浏览

json - RAML:将示例属性添加到包含的 json 模式类型

我想将自定义对象定义为 json 模式文件,并将相关示例定义为单独的文件。我想做这样的事情:

但是对于以“type:”语句开头的行,我收到以下错误消息-“错误:您不能从两种不同类型的类型中继承”

在规范中它说

外部类型不能参与类型继承或特化。换句话说:您不能定义声明新属性或设置构面的外部类型的子类型。但是,您可以创建简单的类型包装器来添加元数据、示例和描述。

我猜这就是问题所在。但我不知道创建“类型包装器”意味着什么。有人可以告诉我实现我想要的最佳方法是什么。

0 投票
3 回答
1278 浏览

mule - RAML: how to export only particular type of XSD

I'm writing a RAML where response is an XML that corresponds to one particular type among many other types defined in an external XSD. Is there a way to specify the particular type name from the XSD when defining parameter in RAML? I.e. now I define it something like this:

But I would like to specify a particular type defined in the xsd to be used as a response type.

Note, that I don't wanna extract the type to a new file.

0 投票
4 回答
5882 浏览

java - 用于 RAML 的 Intellij IDEA 插件

我刚刚开始在我的 Java 项目中使用 RAML。我正在使用 Intellij IDEA,我的 RAML 文件显示为原始文本,没有任何文本突出显示。它似乎根本无法识别这种类型的文件。

Intellij IDEA 中是否有 RAML 插件?

大多数情况下,我尝试用谷歌搜索它并检查插件列表。如果插件不存在,你会建议什么?看来那时我需要使用其他一些工具来正确修改这个文件。

0 投票
1 回答
478 浏览

c# - 使用 .NET 扩展的 RAML 工具防止 RAML 文档出现重复条目

我刚刚开始使用这个工具来定义一个 API 并在 .NET 中搭建 Web API 代码。https://visualstudiogallery.msdn.microsoft.com/cadcb820-762c-4514-9817-884b7558aaa9 我添加了一个 RAML 合约,它在解决方案中创建了一堆控制器和合约。我还运行了启用元数据输出的功能。当我转到 /raml 页面时,我可以看到很棒的 AP​​I 规范。但是,我得到了所有东西的两个版本,我不确定要改变什么来防止它。例如,在我的 .raml 文件中,我有一个名为“operators”的资源。使用这些工具创建一个名为“OperatorsController”的控制器。.raml 定义文件中的 baseUri 为http://localhost:51366/api/WebApiConfig.Register 函数的 MapHttpRoute 设置了 api/{controller}/{id} 的 routeTemplate。在 /raml 页面上有一个 /bookings 条目和一个 /api/Bookings 条目。第一个似乎来自 .raml 规范,第二个来自创建的 BookingsController。 在此处输入图像描述

知道如何防止重复。这是我第一次玩 api 创建,所以我可能在这里遗漏了一些明显的东西......

0 投票
1 回答
714 浏览

api - 使用 RAML 在 Mule 流中处理多个安全方案的最佳方法是什么?

我正在使用 RAML 创建一个 Web 服务 API。

我用两种安全方案创建了 RAML

  • OAuth 2.0
  • 风俗

我的第一种方法是根据请求参数处理授权,其中我在请求中发送一个特殊参数,然后将授权任务委托给任一授权引擎。但它不起作用,当向 OAuth 服务器发出请求时,它会抛出Null Pointer Exception.
然后我知道不同授权方案的授权请求应该有不同的 URI,例如,如果请求 oAuth,那么 URI 应该像 /api/oauth2/authorize?parameters 和其他方案说 oauth 1.0 可以是 /api/oauth1/授权?参数

为了实现这一点,我添加了两个具有不同 URI 模式的 APIkit 路由器流。

在此处输入图像描述

附图中的第一个 APIKit 流程用于自定义授权,第二个用于 OAuth。从图中可以看出,我在第二个流程中的 APIkit 路由器之前添加了 OAuth 验证器。

我想知道这是否是将 OAuth 验证器放在那个地方的正确方法,以便可以对每个请求进行身份验证?或者 OAuth 验证器应该是每个资源流的第一个元素,以便在发出请求后 OAuth 验证单个资源的请求。我还在 OAuth 的某个地方读到过,首先对请求进行身份验证,然后允许访问受保护的资源,在这种情况下,我猜我在 APIKit 路由器之前添加 OAuth 验证器的方法是正确的。但是,我对此不确定,并希望在整个场景中获得第二个建议。

谢谢你。

0 投票
0 回答
295 浏览

oauth-2.0 - Mule 中的 OAuth 2.0 实现

我正在开发一个项目,在该项目中我需要通过 Web 服务公开它的一些方法,并且我正在通过遵循 RAML 使用 Mule 并实现安全性,提出了 OAuth 2.0。我能够验证客户端的“client_id”和“client_secret”,但为此我只在配置文件中提供了凭据。现在我需要从数据库中获取客户详细信息。我尝试使用“preFlow-ref”,并且正在调用另一个流,我可以在其中检索“client_id”和“client_secret”,但不知道如何回调 OAuth。

0 投票
1 回答
311 浏览

raml - RAML formParameters 无法发布方法签名

当我的 raml 定义指定我的服务的 post 方法需要 json 时,生成的 post 方法正确地采用了一个封装该 json 并符合我的模式的对象。

不过,并不是我把post方法改成接受application/x-www-form-encoded formParameters,而是生成的post方法不包含每个参数对应的实参。我期望它错了吗?

之前和工作:

这生成了一个带有签名的 post 方法:

但是将 RAML 更改为:

我本来希望生成的 post 方法是:

但它是:

有人可以解释为什么吗?

谢谢,

保罗