问题标签 [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 回答
413 浏览

oauth - 在同一资源 RAML 下记录对 OAUTH 的多个 POST 请求

我意识到标题可能有点令人困惑,所以这就是我想要实现的目标:

我需要使用 RAML 记录 token_grant 和 token_refresh 方法,这两个方法都是 POST 调用。

token_grant : 生成第一次 OAuth 令牌 token_refresh : 刷新访问令牌

它们的查询参数不同,当然返回结果也不同。问题是它们都在同一个资源下,RAML 只允许对每个资源进行 1 次 POST 调用:

有没有办法解决这个问题,仅限于一个电话后?也许有条件取决于查询参数?

这是token_grant的模板

这是token_refresh的模板:

所以主要问题是如何将这些放在一起

任何帮助表示赞赏非常感谢!

0 投票
2 回答
1842 浏览

raml - RAML trait 参数默认值

在 RAML 中定义特征时,可以对其进行参数化,例如

具有由具有 此特征<<example>>的资源提供的参数,如下所示:

是否可以为特征参数指定默认值,以便具有默认值的资源可以省略该参数?

0 投票
1 回答
863 浏览

maven - RAML 验证抛出“无效值类型”

我尝试验证linkedin.raml,但由于某种原因,我得到了以下一组验证错误。

下面是我用来验证 RAML 的代码片段

这是预期的吗?如果不是,是什么原因造成的?如需更多参考,请查找我在我的轨道包中使用的一组 mvn 依赖项。

在此处输入图像描述

显然在行号的linkedin.raml :178 中导致了这个问题。为什么是这样?

0 投票
2 回答
1009 浏览

node.js - 使用 Node/JS REST API 提供文档

我正在寻找使用 Node 和 Express 构建 REST API,并且我想提供文档。我不想手工制作这个,似乎有 Swagger、RAML 和 Api Blueprint/Apiary 形式的解决方案。

我真正想要的是让文档从 API 代码自动生成,这在 .NET 领域中使用 Swashbuckle 或 Microsoft 提供的解决方案是可能的,但它们是通过强类型和反射实现的。

对于 JS 世界,似乎正确的选择是使用 Swagger/RAML/Api 蓝图标记来定义 API,然后生成文档并从中构建服务器。前者看起来很简单,但我对后者不太确定。我所看到的所有这些选项的服务器代码生成似乎非常有限。需要某种方法将自动生成的代码与手动代码分开,以便可以轻松更新定义,我没有看到任何迹象或讨论。这似乎不是一个无法克服的问题(我对 .NET 比对 JS 更熟悉,所以我很容易遗漏一些东西),并且在上一个Stack Overflow 问题中提到了这个问题和解决方案。一年前。

谁能告诉我我是否遗漏/误解了任何内容以及是否存在上述问题的任何解决方案?

0 投票
1 回答
1242 浏览

java - 自动 JAX-RX 到 RAML

我已经使用 resteasy 编写了我的 Java 项目的 Web 服务。对于文档过程,我希望使用 RAML 捕获这些 Web 服务。

为此,我可以找到一个 RAML 的 eclipse 插件,它会生成一个 .raml 文件。但是我们必须手动完成,即点击类文件或包来生成raml文件。

所以我的问题是 - 是否有一种方法可以在项目打包期间生成所有用于 Web 服务或包下的类,一个 raml 文件。

说在构建过程中使用 Maven。

请建议

0 投票
1 回答
168 浏览

api - raml 语法 - 嵌套 API 资源名称 - 大括号的使用

一个标准的 raml 示例:

资源是:

所以,如果我想在这个文档中添加更多的 API,我可以这样做:

我的问题是,如果以下是合法的?

如果是,raml 如何区分以下 API?(例如,“上传”的 songId)

如果不是,那么只要大括号 {} 出现在任何级别,就不能为该级别定义更多资源?那么在这种情况下我应该如何定义上传 API 呢?

0 投票
1 回答
703 浏览

java - Dropwizard + Raml -> 空资源

当我启动服务器时,会出现一条警告,指出我的资源为空(导致 404):

拉姆:

执行:

在 Application#run 我只是执行以下操作:environment.jersey().register(SayHello.class);

0 投票
3 回答
212 浏览

raml - Mulesoft API Designer 自动加载 RAML 文件

我可以看到如何使用 API Designer 导入/导出包含 RAML 文件的 zip 文件。

我想将 API Designer 的 URL 提供给某人以查看我创建的 RAML 文件。

有没有办法自动将 zip 文件(可能从 URL)导入 API Designer,而不必向他们发送 zip 文件并让他们导入它?

0 投票
1 回答
1480 浏览

maven - Anypoint studio 中的 RAML 文件示例

我目前遵循本教程:https ://docs.mulesoft.com/anypoint-platform-for-apis/creating-an-apikit-project-with-maven但我在创建 RAML 文件时遇到问题我不知道如何做到这一点,我必须从这两个 API 中获取信息: • http://www.programmableweb.com/api/wikipedia
http://www.programmableweb.com/api/weather-channel

Schemas是什么需要使用的?最终目标是创建一个 API,提供有关城市和国家/地区的一些信息。为此,我需要与其他一些 API 提供者(上面的两个链接)进行通信以获取信息并制作 JSON 响应以返回所需的信息。

0 投票
1 回答
481 浏览

api - raml 1.0 响应类型

我正在尝试构建 RAML 文档(v 1.0),但我在最初阶段就被卡住了。我有供应商资源,我定义如下:

我只是无法弄清楚在 get 请求上为 type 写什么(现在是 ???)api 以 vendor 类型的对象数组进行响应,但我该如何将其传达给 RAML?